Package jetbrains.buildServer.vcs

Interface VcsModification

All Superinterfaces:

Comparable<VcsModification>, Modification

All Known Subinterfaces:

SVcsModification, VcsModificationEx

All Known Implementing Classes:

AbstractVcsModification, DBVcsModification, DuplicateVcsModification, MockVcsModification, MockVcsModificationWithId, ModificationDataWrapper, PersonalVcsModificationImpl

public interface VcsModification
extends Comparable<VcsModification>, Modification

VcsModification object describes a single commit of a user made to particular VCS. On the server-side, there is also SVcsModification extension.

Method Summary

Modifier and Type	Method	Description
VcsFileModification	findChangeByPath(String fileName)	Find file modification corresponding to given fileName, may be null.
int	getChangeCount()	Return number of files changed in this modification
List<VcsFileModification>	getChanges()	Returns list of file modifications related to the change
String	getDisplayVersion()
long	getId()	Unique identifier for the modification
String	getVersion()
String	getVersionControlName()	Return version control name as returned by VcsSupportConfig.getDisplayName(); for personal builds "Remote Run" string is returned.
boolean	isPersonal()	Return true if this modification corresponds to personal change of personal build or pre-tested commit

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface jetbrains.buildServer.vcs.Modification

getDescription, getUserName, getVcsDate

Method Detail

getId

long getId()

Unique identifier for the modification

Returns:

unique identifier of the modification

isPersonal

boolean isPersonal()

Return true if this modification corresponds to personal change of personal build or pre-tested commit

Returns:

true if this modification corresponds to personal change of personal build or pre-tested commit

getChanges

@NotNull
List<VcsFileModification> getChanges()

Returns list of file modifications related to the change

Returns:

list of file modifications related to the change

findChangeByPath

@Nullable
VcsFileModification findChangeByPath(String fileName)

Find file modification corresponding to given fileName, may be null. The fileName should exactly match the value from VcsChangeInfo.getFileName()

Parameters:

fileName - name a file to search for

Returns:

see above

getChangeCount

int getChangeCount()

Return number of files changed in this modification

Returns:

see above

getVersion

@NotNull
String getVersion()

getDisplayVersion

@Nullable
String getDisplayVersion()

getVersionControlName

String getVersionControlName()

Return version control name as returned by VcsSupportConfig.getDisplayName(); for personal builds "Remote Run" string is returned.

Returns:

version control name