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 and Description
void	addRepositoryChanges(BuildRepositoryChanges repositoryChanges)
BuildRepositoryChanges	getBuildRepositoryChanges(long repositoryId)
List<CommitContext>	getChanges() Get changes from all repositories
List<CommitContext>	getChanges(long repositoryId) List of Commit objects that triggered off this particular build.
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)
String	getVcsLastChangeRevisionKey(long repositoryId) Deprecated. since 5.11 this value is not longer provided as it's too costly
PlanVcsRevisionData	getVcsRevisionData(long repositoryId) Returns PlanVcsRevisionData containing Repository dependent vcs revision data for this checkout.
String	getVcsRevisionKey(long repositoryId) Returns a Repository dependent "id" for this checkout.
void	setChanges(long repositoryId, List<CommitContext> changes)
void	setIntegrationBranchRevisionData(PlanVcsRevisionData integrationBranchRevisionData)
void	setIntegrationRepositoryId(long integrationRepositoryId)
void	setPreviousVcsRevisionKey(long repositoryId, String previousVcsRevisionKey)
void	setSkippedCommitsCount(long repositoryId, int skippedCommitsCount)
void	setVcsLastChangeRevisionKey(long repositoryId, String vcsRevisionKeyForSubpath) Deprecated. since 5.11 this method has no effect
void	setVcsRevisionKey(long repositoryId, String vcsRevisionKey)

Method Detail

addRepositoryChanges

void addRepositoryChanges(@NotNull
                          BuildRepositoryChanges repositoryChanges)

getRepositoryChanges

Iterable<BuildRepositoryChanges> getRepositoryChanges()

getVcsRevisionKey

@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
                       String vcsRevisionKey)

getVcsRevisionData

@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
                               String previousVcsRevisionKey)

getVcsLastChangeRevisionKey

@Deprecated
String getVcsLastChangeRevisionKey(long repositoryId)

Deprecated. since 5.11 this value is not longer provided as it's too costly

Returns:

always null

setVcsLastChangeRevisionKey

@Deprecated
void setVcsLastChangeRevisionKey(long repositoryId,
                                             String vcsRevisionKeyForSubpath)

Deprecated. since 5.11 this method has no effect

getChanges

@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
List<CommitContext> getChanges()

Get changes from all repositories

Returns:

setChanges

void setChanges(long repositoryId,
                @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
PlanVcsRevisionData getIntegrationBranchRevisionData()

setIntegrationBranchRevisionData

void setIntegrationBranchRevisionData(@NotNull
                                      PlanVcsRevisionData integrationBranchRevisionData)

getBuildRepositoryChanges

@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.