jetbrains.buildServer.serverSide.parameters

Class AbstractBuildParametersProvider

java.lang.Object

jetbrains.buildServer.serverSide.parameters.AbstractBuildParametersProvider

All Implemented Interfaces:

BuildParametersProvider, ServerExtension, TeamCityExtension

public class AbstractBuildParametersProvider
extends java.lang.Object
implements BuildParametersProvider

Adapter class for BuildParametersProvider

Constructor Summary

Constructors

Constructor and Description
AbstractBuildParametersProvider()

Method Summary

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

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 java.util.Map<java.lang.String,java.lang.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. For example, emulation mode is used to show parameters available for a build configuration in the web UI.

Returns:

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

getParametersAvailableOnAgent

@NotNull
public java.util.Collection<java.lang.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