jetbrains.buildServer.vcs
Interface VcsRootInstance

All Superinterfaces:
java.lang.Comparable<SVcsRoot>, jetbrains.buildServer.log.Loggable, SPersistentEntity, SVcsRoot, VcsRoot, XmlExternalizable

public interface VcsRootInstance
extends SVcsRoot

Represents instance of VCS root settings (i.e. settings with all parameters resolved).

Since:
6.5

Field Summary
 
Fields inherited from interface jetbrains.buildServer.vcs.VcsRoot
SECURE_PROPERTY_PREFIX
 
Method Summary
<T extends VcsService>
T
findService(java.lang.Class<T> serviceClass, CheckoutRules checkoutRules)
          Return Vcs service specified by a class passed to the method, or null if the service is not available to the VCS Root instance.
 long getCheckoutPropertiesHash()
           
 RepositoryVersion getCurrentRevision()
           
 RepositoryVersion getLastUsedRevision()
           
 SVcsRoot getParent()
          The parent entity.
 long getParentId()
           
<T extends VcsService>
T
getService(java.lang.Class<T> serviceClass)
          Return Vcs service specified by a class passed to the method.
 java.lang.String getVersionDisplayName(java.lang.String version)
           
 boolean isCurrentVersionExpensive()
           
 void persist()
          Not supported for this object, can be called for parent VCS root only.
 
Methods inherited from interface jetbrains.buildServer.vcs.SVcsRoot
checkAccessibleFrom, checkAccessibleFrom, getConfigurationFile, getDescription, getExternalId, getModificationCheckInterval, getNumberOfUsagesInProjects, getProject, getScope, getUsages, getUsagesInProjects, getVcsDisplayName, isAccessibleFrom, isAccessibleFrom, isUseDefaultModificationCheckInterval, moveToProject, remove, restoreDefaultModificationCheckInterval, setExternalId, setModificationCheckInterval, setName, setProperties, setVcsName
 
Methods inherited from interface jetbrains.buildServer.vcs.VcsRoot
convertToPresentableString, convertToString, getId, getName, getProperties, getPropertiesHash, getProperty, getProperty, getPublicProperties, getVcsName
 
Methods inherited from interface jetbrains.buildServer.log.Loggable
describe
 
Methods inherited from interface jetbrains.buildServer.serverSide.SPersistentEntity
getName
 
Methods inherited from interface jetbrains.buildServer.XmlExternalizable
writeTo
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

isCurrentVersionExpensive

boolean isCurrentVersionExpensive()
Since:
8.0

getCurrentRevision

@NotNull
RepositoryVersion getCurrentRevision()
                                     throws VcsException
Returns:
current revision in VCS for this VCS root (same as VcsSupportCore.getCurrentVersion(VcsRoot)).
Throws:
VcsException
Since:
6.5

getVersionDisplayName

@NotNull
java.lang.String getVersionDisplayName(@NotNull
                                               java.lang.String version)
                                       throws VcsException
Parameters:
version -
Returns:
version display name for given version
Throws:
VcsException - in case of any error
Since:
8.0

getLastUsedRevision

@Nullable
RepositoryVersion getLastUsedRevision()
Returns:
previous revision used to collect changes by this VCS root
Since:
6.5

getParentId

long getParentId()
Returns:
id of the parent VCS root object which unresolved parameters were used to construct this instance.

getParent

@NotNull
SVcsRoot getParent()
Description copied from interface: SPersistentEntity
The parent entity.

Specified by:
getParent in interface SPersistentEntity
Returns:
parent VCS root object which unresolved parameters were used to construct this instance.

getCheckoutPropertiesHash

long getCheckoutPropertiesHash()
Returns:
hash of VCS root checkout properties, see VcsSupportConfig.getCheckoutProperties(VcsRoot).

getService

@NotNull
<T extends VcsService> T getService(@NotNull
                                            java.lang.Class<T> serviceClass)
                                throws VcsException
Return Vcs service specified by a class passed to the method.

Parameters:
serviceClass - VCS service class, for services which do not use checkout rules, see VcsService
Returns:
see above
Throws:
VcsException - if service cannot be found/created
Since:
8.0
See Also:
findService(Class,CheckoutRules)

findService

@Nullable
<T extends VcsService> T findService(@NotNull
                                              java.lang.Class<T> serviceClass,
                                              @NotNull
                                              CheckoutRules checkoutRules)
Return Vcs service specified by a class passed to the method, or null if the service is not available to the VCS Root instance.

Parameters:
serviceClass - VCS service class, for services which do not use checkout rules, see VcsService
checkoutRules - Checkout rules which should be passed to the service.
Returns:
see above
Since:
8.0
See Also:
getService(Class)

persist

void persist()
Not supported for this object, can be called for parent VCS root only.

Specified by:
persist in interface SPersistentEntity
Specified by:
persist in interface SVcsRoot