Package com.mooltiverse.oss.nyx.data

Class ReleaseScope

java.lang.Object

com.mooltiverse.oss.nyx.data.ReleaseScope

public class ReleaseScope
extends Object

This is a value object that models the summary data about the scope of a release.

Constructor Summary

Constructors

Constructor	Description
ReleaseScope()	Default constructor.
ReleaseScope(Version previousVersion, String previousVersionCommit, String initialCommit, String finalCommit, Boolean significant)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getFinalCommit()	Returns the SHA-1 identifier of the last commit within the scope.
String	getInitialCommit()	Returns the SHA-1 identifier of the first commit within the scope.
Version	getPreviousVersion()	Returns the version identifier of the most recent past release.
String	getPreviousVersionCommit()	Returns the SHA-1 identifier of the most recent past release commit.
Boolean	getSignificant()	Returns the flag telling if the release scope contains significant commits.
void	setFinalCommit(String finalCommit)	Sets the SHA-1 identifier of the last commit within the scope.
void	setInitialCommit(String initialCommit)	Sets the SHA-1 identifier of the first commit within the scope.
void	setPreviousVersion(Version previousVersion)	Sets the version identifier of the most recent past release.
void	setPreviousVersionCommit(String previousVersionCommit)	Sets the SHA-1 identifier of the most recent past release commit.
void	setSignificant(Boolean significant)	Sets the flag telling if the release scope contains significant commits.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReleaseScope

public ReleaseScope()

Default constructor.

ReleaseScope

public ReleaseScope(Version previousVersion,
                    String previousVersionCommit,
                    String initialCommit,
                    String finalCommit,
                    Boolean significant)

Constructor.

Parameters:

previousVersion - the version identifier of the most recent past release. It may be null.

previousVersionCommit - the SHA-1 identifier of the most recent past release commit. It may be null.

initialCommit - the SHA-1 identifier of the first commit within the scope. It may be null.

finalCommit - the SHA-1 identifier of the last commit within the scope. It may be null.

significant - the flag telling if the release scope contains significant commits. It may be null.

Method Detail

getPreviousVersion

public Version getPreviousVersion()

Returns the version identifier of the most recent past release.

Returns:

the version identifier of the most recent past release. It may be null.

setPreviousVersion

public void setPreviousVersion(Version previousVersion)

Sets the version identifier of the most recent past release.

Parameters:

previousVersion - the version identifier of the most recent past release. It may be null.

getPreviousVersionCommit

public String getPreviousVersionCommit()

Returns the SHA-1 identifier of the most recent past release commit.

Returns:

the SHA-1 identifier of the most recent past release commit. It may be null.

setPreviousVersionCommit

public void setPreviousVersionCommit(String previousVersionCommit)

Sets the SHA-1 identifier of the most recent past release commit.

Parameters:

previousVersionCommit - the SHA-1 identifier of the most recent past release commit. It may be null.

getInitialCommit

public String getInitialCommit()

Returns the SHA-1 identifier of the first commit within the scope.

Returns:

the SHA-1 identifier of the first commit within the scope. It may be null.

setInitialCommit

public void setInitialCommit(String initialCommit)

Sets the SHA-1 identifier of the first commit within the scope.

Parameters:

initialCommit - the SHA-1 identifier of the first commit within the scope. It may be null.

getFinalCommit

public String getFinalCommit()

Returns the SHA-1 identifier of the last commit within the scope.

Returns:

the SHA-1 identifier of the last commit within the scope. It may be null.

setFinalCommit

public void setFinalCommit(String finalCommit)

Sets the SHA-1 identifier of the last commit within the scope.

Parameters:

finalCommit - the SHA-1 identifier of the last commit within the scope. It may be null.

getSignificant

public Boolean getSignificant()

Returns the flag telling if the release scope contains significant commits.

Returns:

the flag telling if the release scope contains significant commits. It may be null.

setSignificant

public void setSignificant(Boolean significant)

Sets the flag telling if the release scope contains significant commits.

Parameters:

significant - the flag telling if the release scope contains significant commits. It may be null.