Package jetbrains.buildServer.serverSide

Interface InheritableUserParametersHolder

All Superinterfaces:

ReadOnlyUserParameters, UserParametersHolder

All Known Subinterfaces:

BuildTypeEx, BuildTypeSettings, BuildTypeSettingsEx, BuildTypeTemplate, BuildTypeTemplateEx, InheritableUserParametersHolderEx, ProjectEx, RemoteBuildType, RemoteBuildTypeEx, SBuildType, SProject

All Known Implementing Classes:

BuildTypeImpl, BuildTypeSettingsImpl, BuildTypeTemplateImpl, DummyBuildType, EditableBuildTypeCopy, EditableTemplateCopy, InaccessibleTemplate, InheritableUserParametersHolderAdapter, InheritableUserParametersHolderImpl, MockBuildType, ParametersViewBean, ProjectImpl, RemoteBuildTypeImpl, SecuredBuildType, SecuredBuildTypeTemplate, SecuredProject

public interface InheritableUserParametersHolder
extends UserParametersHolder

Represents parameters holder with inheritance of parameters.

Since:

8.0

Method Summary

Modifier and Type	Method	Description
Collection<Parameter>	getInheritedParametersCollection()
Parameter	getOwnParameter(String paramName)
Map<String,String>	getOwnParameters()
Collection<Parameter>	getOwnParametersCollection()
Collection<Parameter>	getOwnParametersWithoutInheritedSpec()
Map<String,String>	getParameters()	Returns map of build and configuration parameters.
Collection<Parameter>	getParametersCollection()	Returns build and configuration parameters in single collection.

Methods inherited from interface jetbrains.buildServer.serverSide.ReadOnlyUserParameters

getParameter, getParameterValue

Methods inherited from interface jetbrains.buildServer.serverSide.UserParametersHolder

addParameter, removeParameter

Method Detail

getParametersCollection

@NotNull
Collection<Parameter> getParametersCollection()

Description copied from interface: ReadOnlyUserParameters

Returns build and configuration parameters in single collection.

Specified by:

getParametersCollection in interface ReadOnlyUserParameters

Returns:

merged collection of parameters, i.e. all parameters inherited from parent holders and own parameters

getParameters

@NotNull
Map<String,String> getParameters()

Description copied from interface: ReadOnlyUserParameters

Returns map of build and configuration parameters.

Specified by:

getParameters in interface ReadOnlyUserParameters

Returns:

merged map of parameters, i.e. all parameters inherited from parent holders and own parameters

getOwnParametersCollection

@NotNull
Collection<Parameter> getOwnParametersCollection()

Returns:

own parameters, without inherited. Yet they would have inherited specs or values (if any).

getOwnParameters

@NotNull
Map<String,String> getOwnParameters()

Returns:

own parameters map, without inherited. Yet they would have inherited specs or values (if any).

getOwnParameter

@Nullable
Parameter getOwnParameter(@NotNull
                          String paramName)

Parameters:

paramName - parameter name

Returns:

own parameter with given name or null if there is no such parameter

Since:

10.0

getOwnParametersWithoutInheritedSpec

@NotNull
Collection<Parameter> getOwnParametersWithoutInheritedSpec()

Returns:

own parameters as is, with own parameters spec.

Since:

2019.2

getInheritedParametersCollection

@NotNull
Collection<Parameter> getInheritedParametersCollection()

Returns:

collection of inherited parameters.

Since:

2019.2