jetbrains.buildServer.vcs

Interface LVcsRootInstance

All Superinterfaces:

jetbrains.buildServer.log.Loggable, LVcsRoot, VcsRoot

All Known Subinterfaces:

VcsRootInstance

public interface LVcsRootInstance
extends LVcsRoot

Light interface for VcsRootInstance

Since:

8.1

Author:

Eugene Petrenko (eugene.petrenko@jetbrains.com)

Field Summary

Fields inherited from interface jetbrains.buildServer.vcs.VcsRoot

SECURE_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method and Description
<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(boolean serverSideCheckout)
long	getParentId()
<T extends VcsService> T	getService(java.lang.Class<T> serviceClass) Return Vcs service specified by a class passed to the method.
<T extends VcsService> T	getService(java.lang.Class<T> serviceClass, CheckoutRules checkoutRules) Return Vcs service specified by a class passed to the method.
VcsRootStatus	getStatus()
java.lang.String	getVersionDisplayName(java.lang.String version) Creates human-readable revision representation, it's likely to make this method unused by reporting all data strait from VCS plugins
boolean	isCurrentVersionExpensive()

Methods inherited from interface jetbrains.buildServer.vcs.LVcsRoot

getDescription, getVcsDisplayName

Methods inherited from interface jetbrains.buildServer.vcs.VcsRoot

getId, getName, getProperties, getProperty, getProperty, getVcsName

Methods inherited from interface jetbrains.buildServer.log.Loggable

describe

Method Detail

isCurrentVersionExpensive

boolean isCurrentVersionExpensive()

Since:

8.0

getParentId

long getParentId()

Returns:

id of the parent VCS root object which unresolved parameters were used to construct this instance.

getVersionDisplayName

@NotNull
java.lang.String getVersionDisplayName(@NotNull
                                                java.lang.String version)
                                         throws VcsException

Creates human-readable revision representation, it's likely to make this method unused by reporting all data strait from VCS plugins

Parameters:

version - version to represent

Returns:

version display name for given version

Throws:

VcsException - in case of any error

Since:

8.0

getCheckoutPropertiesHash

long getCheckoutPropertiesHash(boolean serverSideCheckout)

Parameters:

serverSideCheckout - if true, the hash is calculated for server-side checkout (there could be different hash sets for agent-side checkout and server-side checkout operations)

Returns:

hash of VCS root checkout properties, see VcsSupportConfig.getCheckoutProperties(VcsRoot) and VcsSupportConfig.getServerCheckoutProperties(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)

getService

<T extends VcsService> T getService(@NotNull
                                    java.lang.Class<T> serviceClass,
                                    @NotNull
                                    CheckoutRules checkoutRules)
                             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

checkoutRules - checkout rules

Returns:

see above

Throws:

VcsException - if service cannot be found/created

Since:

8.0, 8.1

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)

getStatus

@NotNull
VcsRootStatus getStatus()

Returns:

VcsRootInstance status

Since:

10.0