com.atlassian.bamboo.build
Interface VariableBuilderBean

All Known Implementing Classes:

VariableBuilderBeanImpl

public interface VariableBuilderBean

Builds a map of Bamboo variables given a BuildContext that contains Global, capability, custom build data, build number and build key values as variables.

Method Summary

java.util.Map<java.lang.String,java.lang.String>	filterVariablesByName(BuildContext buildContext, java.util.Set<java.lang.String> variableNames) Returns a map of Bamboo variables given the BuildContext and a Set of variableNames to filter Note that keys are not prefixed with "bamboo."
java.util.Map<java.lang.String,java.lang.String>	getVariables() Retrieve all of the available variables
java.util.Map<java.lang.String,java.lang.String>	getVariables(BuildContext buildContext) Returns a map of Bamboo variables given the BuildContext Note that keys are not prefixed with "bamboo."

Method Detail

getVariables

@NotNull
java.util.Map<java.lang.String,java.lang.String> getVariables(@Nullable
                                                                      BuildContext buildContext)

Returns a map of Bamboo variables given the BuildContext Note that keys are not prefixed with "bamboo."

Parameters:

buildContext -

Returns:

map

filterVariablesByName

@NotNull
java.util.Map<java.lang.String,java.lang.String> filterVariablesByName(@Nullable
                                                                               BuildContext buildContext,
                                                                               @Nullable
                                                                               java.util.Set<java.lang.String> variableNames)

Returns a map of Bamboo variables given the BuildContext and a Set of variableNames to filter

Note that keys are not prefixed with "bamboo."

Parameters:

buildContext -

variableNames - if null this method will return all variables available

Returns:

variables

getVariables

@NotNull
java.util.Map<java.lang.String,java.lang.String> getVariables()

Retrieve all of the available variables

Returns:

variables