Package jetbrains.buildServer.vcs

Class CommitDataBean

java.lang.Object

jetbrains.buildServer.vcs.BaseCommitData

jetbrains.buildServer.vcs.CommitDataBean

All Implemented Interfaces:

CommitData, CommitInfo

public class CommitDataBean
extends BaseCommitData
implements CommitInfo

This class is expected to be created from plugin code, provides implementation for CommitData

Since:

8.1

Author:

Eugene Petrenko (eugene.petrenko@jetbrains.com)

Constructor Summary

Constructors

Constructor	Description
CommitDataBean(String version, String displayVersion, Date vcsDate)

Method Summary

Modifier and Type	Method	Description
void	addBranch(String branch)	Adds branch for this commit
void	addHead(String head)	adds one more head
void	addMountPoint(CommitMountPointInfo point)
void	addMountPoints(Collection<? extends CommitMountPointInfo> points)
void	addTag(String tag)	Adds tag for this commit
List<String>	getBranches()
String	getCommitAuthor()
String	getCommitMessage()
List<String>	getHeadNames()	Repository's current state contains a number of named commits.
List<CommitMountPointInfo>	getMountPoints()
List<String>	getTags()
boolean	isIncludedByCheckoutRules()
void	setBranches(Collection<String> branches)	Replaces branches list for this commit
void	setCommitAuthor(String commitAuthor)
void	setCommitMessage(String commitMessage)
void	setHeads(Collection<String> heads)	Replaces current heads with given
void	setIncludedByCheckoutRules(boolean isIncludedByCheckoutRules)	Sets if this commit is included by checkout rules
void	setTags(Collection<String> tags)	Replaces tags list for this commit
String	toString()

Methods inherited from class jetbrains.buildServer.vcs.BaseCommitData

addParentRevision, equals, equalsImpl, getAttributes, getDisplayVersion, getParentRevisions, getVcsDate, getVersion, hashCode, setAttribute, setAttributes, setParentRevisions

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jetbrains.vcs.api.CommitData

getAttributes, getDisplayVersion, getParentRevisions, getVcsDate, getVersion

Constructor Detail

CommitDataBean

public CommitDataBean(@NotNull
                      String version,
                      @NotNull
                      String displayVersion,
                      @NotNull
                      Date vcsDate)

Method Detail

getCommitAuthor

public String getCommitAuthor()

Specified by:

getCommitAuthor in interface CommitInfo

Returns:

commit author associated with it

setCommitAuthor

public void setCommitAuthor(@NotNull
                            String commitAuthor)

getCommitMessage

public String getCommitMessage()

Specified by:

getCommitMessage in interface CommitInfo

Returns:

commit message

setCommitMessage

public void setCommitMessage(@NotNull
                             String commitMessage)

addTag

public void addTag(@NotNull
                   String tag)

Adds tag for this commit

Parameters:

tag - parent revision

Since:

8.1

setTags

public void setTags(@NotNull
                    Collection<String> tags)

Replaces tags list for this commit

Parameters:

tags - parent revisions

Since:

8.1

getTags

@NotNull
public List<String> getTags()

Specified by:

getTags in interface CommitInfo

Returns:

tags for commit

addBranch

public void addBranch(@NotNull
                      String branch)

Adds branch for this commit

Parameters:

branch - parent revision

Since:

8.1

setBranches

public void setBranches(@NotNull
                        Collection<String> branches)

Replaces branches list for this commit

Parameters:

branches - parent revisions

Since:

8.1

getBranches

@NotNull
public List<String> getBranches()

Specified by:

getBranches in interface CommitInfo

Returns:

branches to which commit belongs or empty list if nothing is known

addHead

public void addHead(@NotNull
                    String head)

adds one more head

Since:

8.1

setHeads

public void setHeads(@NotNull
                     Collection<String> heads)

Replaces current heads with given

Since:

8.1

getHeadNames

@NotNull
public List<String> getHeadNames()

Description copied from interface: CommitInfo

Repository's current state contains a number of named commits. We name those commits 'heads' This method returns association of a commit with heads that are on the commit

Specified by:

getHeadNames in interface CommitInfo

Returns:

all head names that are on this commit

addMountPoint

public void addMountPoint(@NotNull
                          CommitMountPointInfo point)

Since:

8.1

addMountPoints

public void addMountPoints(@NotNull
                           Collection<? extends CommitMountPointInfo> points)

Since:

8.1

getMountPoints

@NotNull
public List<CommitMountPointInfo> getMountPoints()

Specified by:

getMountPoints in interface CommitInfo

Returns:

mount points detected for the commit

isIncludedByCheckoutRules

public boolean isIncludedByCheckoutRules()

Specified by:

isIncludedByCheckoutRules in interface CommitInfo

Returns:

true if commit is not filtered by checkout rules

setIncludedByCheckoutRules

public void setIncludedByCheckoutRules(boolean isIncludedByCheckoutRules)

Sets if this commit is included by checkout rules

Parameters:

isIncludedByCheckoutRules - set to true to include the commit by checkout rules

Since:

8.1

toString

public String toString()

Overrides:

toString in class BaseCommitData