jetbrains.buildServer.vcs
Interface SVcsModification

All Superinterfaces:
java.lang.Comparable<VcsModification>, Modification, VcsModification

public interface SVcsModification
extends VcsModification

Server side vcs modification class.


Method Summary
 java.util.List<java.lang.Long> getCommitterIds()
          Returns committers ids.
 java.util.List<FilteredVcsChange> getFilteredChanges(BuildPromotion buildPromotion)
          Returns list of changed files filtered according to checkout rules of the specified build promotion
 java.util.List<FilteredVcsChange> getFilteredChanges(SBuild build)
          Returns list of changed files filtered according to checkout rules of the specified build
 java.util.List<FilteredVcsChange> getFilteredChanges(SBuildType buildType)
          Returns list of changed files filtered according to checkout rules of the specified build configuration
 java.util.Map<SBuildType,SBuild> getFirstBuilds()
          Returns map of build configuration -> build where this modification was included for the first time.
 int getNumberOfRelatedConfigurations()
          Returns overall number of build configurations where this modification appeared.
 java.util.Collection<SBuildType> getRelatedConfigurations()
          Returns collection of build configurations where this modification appeared.
 SVcsRoot getVcsRoot()
          For non-personal modifications returns VCS root where this modification occurred.
 boolean isCommitter(User user)
          Returns if the specified user is committer for the modification.
 
Methods inherited from interface jetbrains.buildServer.vcs.VcsModification
findChangeByPath, getChangeCount, getChanges, getDisplayVersion, getId, getVersion, getVersionControlName, isPersonal
 
Methods inherited from interface java.lang.Comparable
compareTo
 
Methods inherited from interface jetbrains.buildServer.vcs.Modification
getDescription, getUserName, getVcsDate
 

Method Detail

getVcsRoot

SVcsRoot getVcsRoot()
For non-personal modifications returns VCS root where this modification occurred. For personal modifications throws UnsupportedOperationException because personal modification can be from several VCS roots simultaneously.

Returns:
vcs root instance.

isCommitter

boolean isCommitter(User user)
Returns if the specified user is committer for the modification.

Parameters:
user - specified user.
Returns:
if the specified user is committer for the modification.

getCommitterIds

java.util.List<java.lang.Long> getCommitterIds()
Returns committers ids.

Returns:
ids of the committers to this change.

getRelatedConfigurations

@NotNull
java.util.Collection<SBuildType> getRelatedConfigurations()
Returns collection of build configurations where this modification appeared.

Returns:
collection of build configurations

getNumberOfRelatedConfigurations

int getNumberOfRelatedConfigurations()
Returns overall number of build configurations where this modification appeared.

Returns:
overall number of build configurations where this modification appeared.

getFilteredChanges

@NotNull
java.util.List<FilteredVcsChange> getFilteredChanges(@NotNull
                                                             SBuildType buildType)
Returns list of changed files filtered according to checkout rules of the specified build configuration

Parameters:
buildType - build configuration
Returns:
list of filtered changed files

getFilteredChanges

@NotNull
java.util.List<FilteredVcsChange> getFilteredChanges(@NotNull
                                                             SBuild build)
Returns list of changed files filtered according to checkout rules of the specified build

Parameters:
build - build
Returns:
list of filtered changed files

getFilteredChanges

@NotNull
java.util.List<FilteredVcsChange> getFilteredChanges(@NotNull
                                                             BuildPromotion buildPromotion)
Returns list of changed files filtered according to checkout rules of the specified build promotion

Parameters:
buildPromotion - build promotion
Returns:
list of filtered changed files

getFirstBuilds

@NotNull
java.util.Map<SBuildType,SBuild> getFirstBuilds()
Returns map of build configuration -> build where this modification was included for the first time. Cancelled and personal builds are ignored.

Returns:
see above