Interface GitCommit
-
- All Known Implementing Classes:
JGitCommit
public interface GitCommitThis interface specifies the basic properties needed for the mojos to access the information about a Git commit- Author:
- Sebastian Staudt
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DategetAuthorDate()Returns the date when this commit has been authoredStringgetAuthorEmailAddress()Returns the email address of the author of this commitStringgetAuthorName()Returns the name of the author of this commitTimeZonegetAuthorTimeZone()Returns the timezone in which this commit has been authoredDategetCommitterDate()Returns the date when this commit has been committedStringgetCommitterEmailAddress()Returns the email address of the committerStringgetCommitterName()Returns the name of the committerTimeZonegetCommitterTimeZone()Returns the timezone in which this commit has been committedStringgetId()Returns the SHA hash ID of this commitStringgetMessage()Returns the message of this commitStringgetMessageSubject()Returns the subject of the commit's messagebooleanisMergeCommit()
-
-
-
Method Detail
-
getAuthorDate
Date getAuthorDate()
Returns the date when this commit has been authored- Returns:
- The author date of this commit
-
getAuthorEmailAddress
String getAuthorEmailAddress()
Returns the email address of the author of this commit- Returns:
- The commit author's email address
-
getAuthorName
String getAuthorName()
Returns the name of the author of this commit- Returns:
- The commit author's name
-
getAuthorTimeZone
TimeZone getAuthorTimeZone()
Returns the timezone in which this commit has been authored- Returns:
- The author timezone of this commit
-
getCommitterDate
Date getCommitterDate()
Returns the date when this commit has been committed- Returns:
- The committer date of this commit
-
getCommitterEmailAddress
String getCommitterEmailAddress()
Returns the email address of the committer- Returns:
- The committer's email address
-
getCommitterName
String getCommitterName()
Returns the name of the committer- Returns:
- The committer's name
-
getCommitterTimeZone
TimeZone getCommitterTimeZone()
Returns the timezone in which this commit has been committed- Returns:
- The committer timezone of this commit
-
getId
String getId()
Returns the SHA hash ID of this commit- Returns:
- The SHA ID of this commit
-
getMessage
String getMessage()
Returns the message of this commit- Returns:
- The message of this commit
-
getMessageSubject
String getMessageSubject()
Returns the subject of the commit's messageThe message subject is the first line of the commit message.
- Returns:
- The message subject of this commit
-
isMergeCommit
boolean isMergeCommit()
- Returns:
trueif this commit is a merge commit
-
-