Package com.atlassian.bamboo.v2.build

Interface BuildChanges

All Superinterfaces:

Serializable

All Known Implementing Classes:

BuildChangesImpl

public interface BuildChanges
extends Serializable

Class that encapsulates the repository changes for a particular build result

Method Summary

Modifier and Type	Method	Description
void	addRepositoryChanges(@NotNull BuildRepositoryChanges repositoryChanges)
@NotNull BuildRepositoryChanges	getBuildRepositoryChanges(long repositoryId)
@NotNull List<CommitContext>	getChanges()	Get changes from all repositories
@NotNull List<CommitContext>	getChanges(long repositoryId)	List of Commit objects that triggered off this particular build.
@Nullable PlanVcsRevisionData	getIntegrationBranchRevisionData()
long	getIntegrationRepositoryId()
String	getPreviousVcsRevisionKey(long repositoryId)	Returns a Repository dependent "id" for previous state of repository, so change is between previousVcsRevisionKey and vcsRevisionKey This is value is taken from the Repository as to be internally consistent
Iterable<BuildRepositoryChanges>	getRepositoryChanges()
int	getSkippedCommitsCount(long repositoryId)	The number of commits that were included in this buildChanges, but their details were skipped (because there was too many commits to keep them all in this buildChanges)
@NotNull PlanVcsRevisionData	getVcsRevisionData(long repositoryId)	Returns PlanVcsRevisionData containing Repository dependent vcs revision data for this checkout.
@Nullable String	getVcsRevisionKey(long repositoryId)	Returns a Repository dependent "id" for this checkout.
void	setChanges(long repositoryId, @NotNull List<CommitContext> changes)
void	setIntegrationBranchRevisionData(@NotNull PlanVcsRevisionData integrationBranchRevisionData)
void	setIntegrationRepositoryId(long integrationRepositoryId)
void	setPreviousVcsRevisionKey(long repositoryId, @Nullable String previousVcsRevisionKey)
void	setSkippedCommitsCount(long repositoryId, int skippedCommitsCount)
void	setVcsRevisionKey(long repositoryId, @NotNull String vcsRevisionKey)

Method Detail

addRepositoryChanges

void addRepositoryChanges(@NotNull
                          @NotNull BuildRepositoryChanges repositoryChanges)

getRepositoryChanges

Iterable<BuildRepositoryChanges> getRepositoryChanges()

getVcsRevisionKey

@Nullable
@Nullable String getVcsRevisionKey(long repositoryId)

Returns a Repository dependent "id" for this checkout. e.g. revision number for SVN etc. This is value is taken from the Repository as to be internally consistent

Returns:

Revision "id"

setVcsRevisionKey

void setVcsRevisionKey(long repositoryId,
                       @NotNull
                       @NotNull String vcsRevisionKey)

getVcsRevisionData

@NotNull
@NotNull PlanVcsRevisionData getVcsRevisionData(long repositoryId)

Returns PlanVcsRevisionData containing Repository dependent vcs revision data for this checkout.

Parameters:

repositoryId -

Returns:

getPreviousVcsRevisionKey

String getPreviousVcsRevisionKey(long repositoryId)

Returns a Repository dependent "id" for previous state of repository, so change is between previousVcsRevisionKey and vcsRevisionKey This is value is taken from the Repository as to be internally consistent

Returns:

setPreviousVcsRevisionKey

void setPreviousVcsRevisionKey(long repositoryId,
                               @Nullable
                               @Nullable String previousVcsRevisionKey)

getChanges

@NotNull
@NotNull List<CommitContext> getChanges(long repositoryId)

List of Commit objects that triggered off this particular build. Returns empty collection if no changes returned.

Parameters:

repositoryId -

Returns:

List of Commits. May be empty

getChanges

@NotNull
@NotNull List<CommitContext> getChanges()

Get changes from all repositories

Returns:

setChanges

void setChanges(long repositoryId,
                @NotNull
                @NotNull List<CommitContext> changes)

getSkippedCommitsCount

int getSkippedCommitsCount(long repositoryId)

The number of commits that were included in this buildChanges, but their details were skipped (because there was too many commits to keep them all in this buildChanges)

Returns:

number of skipped commits

setSkippedCommitsCount

void setSkippedCommitsCount(long repositoryId,
                            int skippedCommitsCount)

getIntegrationRepositoryId

long getIntegrationRepositoryId()

setIntegrationRepositoryId

void setIntegrationRepositoryId(long integrationRepositoryId)

getIntegrationBranchRevisionData

@Nullable
@Nullable PlanVcsRevisionData getIntegrationBranchRevisionData()

setIntegrationBranchRevisionData

void setIntegrationBranchRevisionData(@NotNull
                                      @NotNull PlanVcsRevisionData integrationBranchRevisionData)

getBuildRepositoryChanges

@NotNull
@NotNull BuildRepositoryChanges getBuildRepositoryChanges(long repositoryId)

Parameters:

repositoryId - repository id

Returns:

complete BuildRepositoryChanges object for a specified repository id.

Throws:

IllegalArgumentException - if the repository is not included in this changeset.