VcsRootEntry (javadoc 2024.12-174331 API)

java.lang.Object
- jetbrains.vcs.api.VcsSettings
- - jetbrains.buildServer.vcs.VcsRootEntry

All Implemented Interfaces:

Loggable, VcsDataObject

Direct Known Subclasses:

VcsRootInstanceEntry
```
public class VcsRootEntry
extends VcsSettings
```
A pair of VcsRoot and associated CheckoutRules. Usually several such pairs are associated with a build configuration.

Constructor Summary

Constructors
Constructor Description

VcsRootEntry(VcsRoot vcsRoot, CheckoutRules checkoutRules)
create VcsRootEntry

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`CheckoutRules`	`getCheckoutRules()`
`String`	`getCheckoutRulesSpecification()`
`String`	`getSignature()`	Returns signature of this VCS root entry.
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class jetbrains.vcs.api.VcsSettings
describe, getDisplayName, getProperties, getSettingsId, getSshKeys, getVcsName, getVcsRoot

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VcsRootEntry
```
public VcsRootEntry(@NotNull
                    VcsRoot vcsRoot,
                    @NotNull
                    CheckoutRules checkoutRules)
```
    create VcsRootEntry
    
    Parameters:
    
    vcsRoot - corresponding VCS root for the entry
    
    checkoutRules - rules for checking out vcsRoot sources to the build agent
- Method Detail
  - getCheckoutRules
```
@NotNull
public CheckoutRules getCheckoutRules()
```
    Returns:
    
    Checkout rules used to obtain sources of the corresponding VCS root
  - getSignature
```
@NotNull
public String getSignature()
```
    Returns signature of this VCS root entry. Signature is a string composed of vcs root id, vcs root properties and checkout rules. This signature uniquely identifies VCS root entry settings and can be used as a key in various caches.
    
    Returns:
    
    signature of the VCS root entry.
  - getCheckoutRulesSpecification
```
@NotNull
public String getCheckoutRulesSpecification()
```
    Overrides:
    
    getCheckoutRulesSpecification in class VcsSettings
    
    Returns:
    
    checkout rules specification
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class VcsSettings
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class VcsSettings
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class VcsSettings