Package jetbrains.buildServer.vcs
Interface VcsModification
-
- All Superinterfaces:
java.lang.Comparable<VcsModification>
,Modification
- All Known Subinterfaces:
SVcsModification
public interface VcsModification extends java.lang.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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description VcsFileModification
findChangeByPath(java.lang.String fileName)
Find file modification corresponding to given fileName, may be null.int
getChangeCount()
Return number of files changed in this modificationjava.util.List<VcsFileModification>
getChanges()
Returns list of file modifications related to the changejava.lang.String
getDisplayVersion()
long
getId()
Unique identifier for the modificationjava.lang.String
getVersion()
java.lang.String
getVersionControlName()
Return version control name as returned byVcsSupportConfig.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 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 java.util.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(java.lang.String fileName)
Find file modification corresponding to given fileName, may be null. The fileName should exactly match the value fromVcsChangeInfo.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 java.lang.String getVersion()
-
getDisplayVersion
@Nullable java.lang.String getDisplayVersion()
-
getVersionControlName
java.lang.String getVersionControlName()
Return version control name as returned byVcsSupportConfig.getDisplayName()
; for personal builds "Remote Run" string is returned.- Returns:
- version control name
-
-