Package jetbrains.buildServer.serverSide.parameters

Class AbstractBuildParametersProvider

java.lang.Object

jetbrains.buildServer.serverSide.parameters.AbstractBuildParametersProvider

All Implemented Interfaces:

BuildParametersProvider, ServerExtension, TeamCityExtension

Direct Known Subclasses:

AgentlessBuildParametersProvider, ApprovalBuildParametersProvider, AutoToolVersionParametersProvider, BuildBranchParameterProvider, BuildStepsParameterProvider, DefaultAgentParametersProvider, DefaultCheckoutDirParameterProvider, DefaultToolVersionParametersProvider, DependencyParametersProvider, PipelineParametersProvider, ToolsParametersProvider, TriggeredByParametersProvider.TriggeredByParametersProviderImpl, UpperLimitRevisionParametersProvider, VCSSettingsBuildParametersProvider

public class AbstractBuildParametersProvider
extends Object
implements BuildParametersProvider

Adapter class for BuildParametersProvider

Constructor Summary

Constructors

Constructor	Description
AbstractBuildParametersProvider()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getParameters(SBuild build, boolean emulationMode)	Returns additional build parameters.
Collection<String>	getParametersAvailableOnAgent(SBuild build)	Returns collection of parameters (names) always available on the agent for the specified build.
String	getPrefix()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBuildParametersProvider

public AbstractBuildParametersProvider()

Method Detail

getParameters

@NotNull
public Map<String,String> getParameters(@NotNull
                                              SBuild build,
                                              boolean emulationMode)

Description copied from interface: BuildParametersProvider

Returns additional build parameters.

Specified by:

getParameters in interface BuildParametersProvider

Parameters:

build - the build for which parameters should be added

emulationMode - if true then parameters are calculated in the emulation mode and provided build is a mock build. There are two cases when emulationMode is true:

• when a build for which we need to compute parameters is still in the queue
• when parameters should be calculated in a context of a build configuration when there is no build at all

in both of these cases a mock build will be passed to the getParameters() method, however in the first case the method BuildPromotionOwner.getBuildPromotion() will return an instance of a BuildPromotion which is in the queue (BuildPromotion.getQueuedBuild() will return a not null object), while in the second case a mock of BuildPromotion without any associated queued or started builds will be returned

Returns:

the map of the parameter name - parameter value pairs To provide descriptions for the properties ParameterDescriptionProvider

getParametersAvailableOnAgent

@NotNull
public Collection<String> getParametersAvailableOnAgent(@NotNull
                                                        SBuild build)

Description copied from interface: BuildParametersProvider

Returns collection of parameters (names) always available on the agent for the specified build. Because concrete values of these parameters are not known on the server side only names are returned. This collection may not contain parameters returned by BuildParametersProvider.getParameters(jetbrains.buildServer.serverSide.SBuild,boolean). To provide descriptions for the properties ParameterDescriptionProvider

Specified by:

getParametersAvailableOnAgent in interface BuildParametersProvider

Parameters:

build - build

Returns:

see above

getPrefix

@NotNull
public String getPrefix()

Specified by:

getPrefix in interface BuildParametersProvider

Returns:

a common prefix used for all parameter names generated by this provider, returns empty string if there is no common prefix