jetbrains.vcs.api

Class VcsSettings

java.lang.Object

jetbrains.vcs.api.VcsSettings

All Implemented Interfaces:

jetbrains.buildServer.log.Loggable, VcsDataObject

Direct Known Subclasses:

VcsRootEntry

public class VcsSettings
extends java.lang.Object
implements jetbrains.buildServer.log.Loggable, VcsDataObject

This entity contains:

• Vcs plugin name
• Access parameters for version control server (in VcsRoot)
• checkout rules

Since:

TC 8.0

Author:

kir

Constructor Summary

Constructors

Constructor and Description
VcsSettings(long settingsId, java.lang.String vcsName, java.lang.String displayName, java.lang.String checkoutRules, java.util.Map<java.lang.String,java.lang.String> properties)
VcsSettings(long settingsId, java.lang.String vcsName, java.lang.String displayName, java.lang.String checkoutRules, java.util.Map<java.lang.String,java.lang.String> properties, java.util.Map<java.lang.String,java.lang.String> sshKeys)
VcsSettings(VcsRoot vcsRoot, java.lang.String checkoutRules)
VcsSettings(VcsRoot vcsRoot, java.lang.String checkoutRules, java.util.Map<java.lang.String,java.lang.String> sshKeys)

Method Summary

Modifier and Type	Method and Description
java.lang.String	describe(boolean verbose)
boolean	equals(java.lang.Object o)
java.lang.String	getCheckoutRulesSpecification()
java.lang.String	getDisplayName()
java.util.Map<java.lang.String,java.lang.String>	getProperties()
long	getSettingsId()
java.util.Map<java.lang.String,java.lang.String>	getSshKeys()
java.lang.String	getVcsName()
VcsRoot	getVcsRoot() Get VCS Root, associated with these settings.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VcsSettings

public VcsSettings(@NotNull
                   VcsRoot vcsRoot,
                   @NotNull
                   java.lang.String checkoutRules)

VcsSettings

public VcsSettings(@NotNull
                   VcsRoot vcsRoot,
                   @NotNull
                   java.lang.String checkoutRules,
                   @NotNull
                   java.util.Map<java.lang.String,java.lang.String> sshKeys)

VcsSettings

public VcsSettings(long settingsId,
                   @NotNull
                   java.lang.String vcsName,
                   @Nullable
                   java.lang.String displayName,
                   @NotNull
                   java.lang.String checkoutRules,
                   @NotNull
                   java.util.Map<java.lang.String,java.lang.String> properties)

VcsSettings

public VcsSettings(long settingsId,
                   @NotNull
                   java.lang.String vcsName,
                   @Nullable
                   java.lang.String displayName,
                   @NotNull
                   java.lang.String checkoutRules,
                   @NotNull
                   java.util.Map<java.lang.String,java.lang.String> properties,
                   @NotNull
                   java.util.Map<java.lang.String,java.lang.String> sshKeys)

Method Detail

getVcsRoot

@NotNull
public VcsRoot getVcsRoot()

Get VCS Root, associated with these settings.

getSettingsId

public long getSettingsId()

Returns:

associated id for those VCS settings

getDisplayName

@Nullable
public java.lang.String getDisplayName()

Returns:

The name to be shown to user

getVcsName

@NotNull
public java.lang.String getVcsName()

Returns:

VCS plugin name (so far, in TeamCity sense)

getProperties

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

Returns:

VCS configuration properties

getSshKeys

@NotNull
public java.util.Map<java.lang.String,java.lang.String> getSshKeys()

getCheckoutRulesSpecification

@NotNull
public java.lang.String getCheckoutRulesSpecification()

Returns:

checkout rules specification

describe

@NotNull
public java.lang.String describe(boolean verbose)

Specified by:

describe in interface jetbrains.buildServer.log.Loggable

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object