Package jetbrains.vcs.api

Class VcsSettings

java.lang.Object

jetbrains.vcs.api.VcsSettings

All Implemented Interfaces:

Loggable, VcsDataObject

Direct Known Subclasses:

VcsRootEntry

public class VcsSettings
extends Object
implements 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	Description
VcsSettings(long settingsId, String vcsName, String displayName, String checkoutRules, Map<String,String> properties, String externalId)
VcsSettings(long settingsId, String vcsName, String displayName, String checkoutRules, Map<String,String> properties, Map<String,String> sshKeys, String externalId)
VcsSettings(VcsRoot vcsRoot, String checkoutRules)
VcsSettings(VcsRoot vcsRoot, String checkoutRules, Map<String,String> sshKeys)

Method Summary

Modifier and Type	Method	Description
String	describe(boolean verbose)
boolean	equals(Object o)
String	getCheckoutRulesSpecification()
String	getDisplayName()
Map<String,String>	getProperties()
long	getSettingsId()
Map<String,String>	getSshKeys()
String	getVcsName()
VcsRoot	getVcsRoot()	Get VCS Root, associated with these settings.
int	hashCode()
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
                   String checkoutRules)

VcsSettings

public VcsSettings(@NotNull
                   VcsRoot vcsRoot,
                   @NotNull
                   String checkoutRules,
                   @NotNull
                   Map<String,String> sshKeys)

VcsSettings

public VcsSettings(long settingsId,
                   @NotNull
                   String vcsName,
                   @Nullable
                   String displayName,
                   @NotNull
                   String checkoutRules,
                   @NotNull
                   Map<String,String> properties,
                   @NotNull
                   String externalId)

VcsSettings

public VcsSettings(long settingsId,
                   @NotNull
                   String vcsName,
                   @Nullable
                   String displayName,
                   @NotNull
                   String checkoutRules,
                   @NotNull
                   Map<String,String> properties,
                   @NotNull
                   Map<String,String> sshKeys,
                   @NotNull
                   String externalId)

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 String getDisplayName()

Returns:

The name to be shown to user

getVcsName

@NotNull
public String getVcsName()

Returns:

VCS plugin name (so far, in TeamCity sense)

getProperties

@NotNull
public Map<String,String> getProperties()

Returns:

VCS configuration properties

getSshKeys

@NotNull
public Map<String,String> getSshKeys()

getCheckoutRulesSpecification

@NotNull
public String getCheckoutRulesSpecification()

Returns:

checkout rules specification

describe

@NotNull
public String describe(boolean verbose)

Specified by:

describe in interface Loggable

Parameters:

verbose - verbosity of object description

Returns:

description of this object. If verbose is true, description should have mode details.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object