Package com.mooltiverse.oss.nyx.data

Class Commit

java.lang.Object

com.mooltiverse.oss.nyx.data.Commit

public class Commit
extends Object

This object is a Git commit value holder independent from the underlying Git implementation.

Constructor Summary

Constructors

Constructor	Description
Commit(String sha, int date, List<String> parents, Action authorAction, Action commitAction, Message message, Set<Tag> tags)	Constructor.

Method Summary

Modifier and Type	Method	Description
Action	getAuthorAction()	Returns the author data.
Action	getCommitAction()	Returns the committer data.
int	getDate()	Returns the commit date.
Message	getMessage()	Returns the commit message.
List<String>	getParents()	Returns the immutable list of parent commit SHA-1 identifiers.
String	getSHA()	Returns the SHA-1 identifier for the commit.
Set<Tag>	getTags()	Returns the immutable list of tags pointing to this commit.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Commit

public Commit(String sha,
              int date,
              List<String> parents,
              Action authorAction,
              Action commitAction,
              Message message,
              Set<Tag> tags)

Constructor.

Parameters:

sha - the commit SHA-1 identifier. Cannot be null

date - the commit date

parents - the SHA-1 identifiers of parent commits. If the commit has no parents an empty, non null list, must be passed

authorAction - the value holder about the author. Cannot be null

commitAction - the value holder about the committer. Cannot be null

message - the commit message. Cannot be null

tags - the tags applied to this commit. If the commit has no tags an empty, non null set, must be passed

Method Detail

getAuthorAction

public Action getAuthorAction()

Returns the author data.

Returns:

the author data. Never null.

getCommitAction

public Action getCommitAction()

Returns the committer data.

Returns:

the committer data. Never null.

getDate

public int getDate()

Returns the commit date.

Returns:

the commit date.

getMessage

public Message getMessage()

Returns the commit message.

Returns:

the commit message. Never null.

getParents

public List<String> getParents()

Returns the immutable list of parent commit SHA-1 identifiers.

Returns:

the immutable list of parent commit SHA-1 identifiers. May be empty but not null.

getTags

public Set<Tag> getTags()

Returns the immutable list of tags pointing to this commit.

Returns:

the immutable list of tags pointing to this commit. May be empty but not null.

getSHA

public String getSHA()

Returns the SHA-1 identifier for the commit.

Returns:

the SHA-1 identifier for the commit. Never null.

toString

public String toString()

Overrides:

toString in class Object