com.atlassian.bamboo.commit
Interface CommitContext

All Known Subinterfaces:
Commit
All Known Implementing Classes:
CommitContextImpl, CommitImpl

@PublicApi
public interface CommitContext


Method Summary
 Author getAuthor()
           
 String getChangeSetId()
          Return VCS identifier for this changeset.
 String getComment()
           
 Date getDate()
           
 List<CommitFile> getFiles()
           
 String guessChangeSetId()
           
 boolean isForeignCommit()
          True if commit comes from another branch/is not in the ancestry path.
 

Method Detail

getAuthor

Author getAuthor()
Returns:
Author who made the commit

getFiles

@NotNull
List<CommitFile> getFiles()
Returns:
List of CommitFile objects representing changed files

getComment

@NotNull
String getComment()
Returns:
the commit comment

getDate

@NotNull
Date getDate()
Returns:
Date of commit.

getChangeSetId

@Nullable
String getChangeSetId()
Return VCS identifier for this changeset.

Returns:

guessChangeSetId

@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


Copyright © 2015 Atlassian Software Systems Pty Ltd. All rights reserved.