Package jetbrains.buildServer.serverSide.impl

Class SettingsRootInfo

java.lang.Object

jetbrains.buildServer.serverSide.impl.SettingsRootInfo

public final class SettingsRootInfo
extends Object

Helps to organize information about versioned settings VCS roots during changes collecting

Since:

10.0 (09/06/16)

Author:

kir

Constructor Summary

Constructors

Constructor	Description
SettingsRootInfo()

Method Summary

Modifier and Type	Method	Description
void	addSettingsRoot(VcsRootInstance root)	Marks the specified VCS root as a settings root
void	addSettingsRootUsage(VcsRootInstance root, SBuildType bt, CheckoutRules rules, boolean attached)	Adds information about settings checkout rules for the specified VCS root in the specified buildType.
boolean	containsSettingsRoot(VcsRootInstance root)	Returns true if the specified VCS root was marked as settings root
Map<SBuildType,CheckoutRules>	getAllSettingsRootUsages(VcsRootInstance settingsRoot)	Returns all generated settings VCS root usages, includes usages for buildTypes which have the root attached
Set<SBuildType>	getBuildTypesWithImplicitSettingsRoot(VcsRootInstance settingsRoot)	Returns buildTypes where the specified root is used to store settings, but not attached
Map<SBuildType,CheckoutRules>	getImplicitUsages(VcsRootInstance settingsRoot)	Returns implicit usages for the specified VCS root, ie.
boolean	isImplicitSettingsRoot(VcsRootInstance root, SBuildType buildType)	Returns true if the specified VCS root is an implicit settings root added to the given buildType, ie.
boolean	isSettingsVcsRoot(SBuildType buildType, VcsRootInstance root)	Returns true if the specified buildType uses the specified VCS root to store settings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SettingsRootInfo

public SettingsRootInfo()

Method Detail

addSettingsRoot

public void addSettingsRoot(@NotNull
                            VcsRootInstance root)

Marks the specified VCS root as a settings root

Parameters:

root - root to mark

containsSettingsRoot

public boolean containsSettingsRoot(@NotNull
                                    VcsRootInstance root)

Returns true if the specified VCS root was marked as settings root

Parameters:

root - VCS root of interest

Returns:

see above

addSettingsRootUsage

public void addSettingsRootUsage(@NotNull
                                 VcsRootInstance root,
                                 @NotNull
                                 SBuildType bt,
                                 @NotNull
                                 CheckoutRules rules,
                                 boolean attached)

Adds information about settings checkout rules for the specified VCS root in the specified buildType.

Parameters:

root - settings VCS root

bt - buildType for which rules are added

rules - settings checkout rules

attached - whether the root is attached to the buildType, if false, then root is treated as implicit

getBuildTypesWithImplicitSettingsRoot

@NotNull
public Set<SBuildType> getBuildTypesWithImplicitSettingsRoot(@NotNull
                                                             VcsRootInstance settingsRoot)

Returns buildTypes where the specified root is used to store settings, but not attached

Parameters:

settingsRoot - VCS root of interest

Returns:

see above

isImplicitSettingsRoot

public boolean isImplicitSettingsRoot(@NotNull
                                      VcsRootInstance root,
                                      @NotNull
                                      SBuildType buildType)

Returns true if the specified VCS root is an implicit settings root added to the given buildType, ie. this root is used in buildType's project to store settings, but not attached to the buildType.

Parameters:

root - root of interest

buildType - buildType of interest

Returns:

see above

isSettingsVcsRoot

public boolean isSettingsVcsRoot(@NotNull
                                 SBuildType buildType,
                                 @NotNull
                                 VcsRootInstance root)

Returns true if the specified buildType uses the specified VCS root to store settings

Parameters:

buildType - buildType of interest

root - VCS root of interest

Returns:

see above

getImplicitUsages

@NotNull
public Map<SBuildType,CheckoutRules> getImplicitUsages(@NotNull
                                                             VcsRootInstance settingsRoot)

Returns implicit usages for the specified VCS root, ie. usages for buildTypes storing settings in the specified VCS root but without the root attached

Parameters:

settingsRoot - settings root of interest

Returns:

see above

getAllSettingsRootUsages

@NotNull
public Map<SBuildType,CheckoutRules> getAllSettingsRootUsages(@NotNull
                                                                    VcsRootInstance settingsRoot)

Returns all generated settings VCS root usages, includes usages for buildTypes which have the root attached

Parameters:

settingsRoot - settings root of interest

Returns:

see above