Package com.atlassian.bamboo.commit

Interface CommitContext

All Known Subinterfaces:

Commit

All Known Implementing Classes:

CommitContextImpl, CommitImpl, RssNotification.CommitWithUrl

@PublicApi
public interface CommitContext

Method Summary

Modifier and Type	Method	Description
AuthorContext	getAuthorContext()
@Nullable String	getChangeSetId()	Return VCS identifier for this changeset.
@NotNull String	getComment()
@NotNull Date	getDate()
@NotNull List<CommitFile>	getFiles()
@Nullable String	guessChangeSetId()
boolean	isForeignCommit()	True if commit comes from another branch/is not in the ancestry path.

Method Details

getAuthorContext

AuthorContext getAuthorContext()

Returns:

AuthorContext of commit author

getFiles

@NotNull
@NotNull List<CommitFile> getFiles()

Returns:

List of CommitFile objects representing changed files

getComment

@NotNull
@NotNull String getComment()

Returns:

the commit comment

getDate

@NotNull
@NotNull Date getDate()

Returns:

Date of commit.

getChangeSetId

@Nullable
@Nullable String getChangeSetId()

Return VCS identifier for this changeset.

Returns:

guessChangeSetId

@Nullable
@Nullable String guessChangeSetId()

isForeignCommit

boolean isForeignCommit()

True if commit comes from another branch/is not in the ancestry path. (DVCS only) It is allowed to return false negatives but not false positives. Will return false if feature not supported by repository plugin. In some cases (git) may return false even if commit originated in different branch due to git limitations.

Since:

5.5 shipit 26