jetbrains.buildServer.vcs
Interface VcsRoot

All Known Subinterfaces:

SVcsRoot, VcsRootInstance

All Known Implementing Classes:

VcsRootImpl

public interface VcsRoot

Contains configuration settings of a configured version control root. VCS root settings are stored as a set of name value pairs (called properties). Names starting with "teamcity:" prefix are reserved for TeamCity internal usages. Names starting with SECURE_PROPERTY_PREFIX indicate that value of this property contains secure information, such properties are persisted in scrambled form.

Field Summary

static java.lang.String

SECURE_PROPERTY_PREFIX Deprecated. use Constants.SECURE_PROPERTY_PREFIX

Method Summary

java.lang.String	convertToPresentableString() Returns VCS root serialized to string with secure properties values replaced with *****.
java.lang.String	convertToString() Returns the root serialized to string value
long	getId() returns root unique identifier
java.lang.String	getName() returns descriptive name of the vcs root
java.util.Map<java.lang.String,java.lang.String>	getProperties() Returns mapping from a property name to its value
long	getPropertiesHash() Returns hash code computed on the base of this VCS root properties.
java.lang.String	getProperty(java.lang.String propertyName) Provides specified property value
java.lang.String	getProperty(java.lang.String propertyName, java.lang.String defaultValue) Provides specified property value or default value if property is not defined
java.util.Map<java.lang.String,java.lang.String>	getPublicProperties()
java.lang.String	getVcsName() Returns name of the corresponding version control.

Field Detail

SECURE_PROPERTY_PREFIX

@NonNls
static final java.lang.String SECURE_PROPERTY_PREFIX

Deprecated. use Constants.SECURE_PROPERTY_PREFIX

See Also:

Constant Field Values

Method Detail

getVcsName

java.lang.String getVcsName()

Returns name of the corresponding version control.

Returns:

name of the corresponding version control

getProperty

java.lang.String getProperty(java.lang.String propertyName)

Provides specified property value

Parameters:

propertyName - name of the property whose value is requested

Returns:

value of a specified property

getProperty

java.lang.String getProperty(java.lang.String propertyName,
                             java.lang.String defaultValue)

Provides specified property value or default value if property is not defined

Parameters:

propertyName - name of the property whose value is requested

defaultValue - default value which is returned if property value was not specified explicitly

Returns:

- value of a specified property or 'defaultValue' if it is not defined

getProperties

java.util.Map<java.lang.String,java.lang.String> getProperties()

Returns mapping from a property name to its value

Returns:

map of all defined properties

convertToString

java.lang.String convertToString()

Returns the root serialized to string value

Returns:

serialized settings

convertToPresentableString

java.lang.String convertToPresentableString()

Returns VCS root serialized to string with secure properties values replaced with *****.

Returns:

see above

getPropertiesHash

long getPropertiesHash()

Returns hash code computed on the base of this VCS root properties.

Returns:

VCS root properties hash code

getName

java.lang.String getName()

returns descriptive name of the vcs root

Returns:

see above

getId

long getId()

returns root unique identifier

Returns:

see above

getPublicProperties

java.util.Map<java.lang.String,java.lang.String> getPublicProperties()

Returns:

all non secure properties of this VCS root.