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 forBuildParametersProvider
-
-
Constructor Summary
Constructors Constructor Description AbstractBuildParametersProvider()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.java.lang.String
getPrefix()
-
-
-
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 interfaceBuildParametersProvider
- Parameters:
build
- the build for which parameters should be addedemulationMode
- 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
BuildPromotionOwner.getBuildPromotion()
will return an instance of aBuildPromotion
which is in the queue (BuildPromotion.getQueuedBuild()
will return a not null object), while in the second case a mock ofBuildPromotion
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 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 byBuildParametersProvider.getParameters(jetbrains.buildServer.serverSide.SBuild,boolean)
. To provide descriptions for the propertiesParameterDescriptionProvider
- Specified by:
getParametersAvailableOnAgent
in interfaceBuildParametersProvider
- Parameters:
build
- build- Returns:
- see above
-
getPrefix
@NotNull public java.lang.String getPrefix()
- Specified by:
getPrefix
in interfaceBuildParametersProvider
- Returns:
- a common prefix used for all parameter names generated by this provider, returns empty string if there is no common prefix
-
-