Package com.atlassian.bamboo.variable

Interface ImmutableVariableContext

All Superinterfaces:

Serializable

All Known Subinterfaces:

VariableContext

All Known Implementing Classes:

VariableContextImpl

@PublicApi
public interface ImmutableVariableContext
extends Serializable

A read-only bag for all variable related data inside CommonContext

Since:

9.5

Method Summary

Modifier and Type	Method	Description
@NotNull Map<String,VariableDefinitionContext>	getEffectiveVariables()	Effective state of the variables.
@NotNull Map<String,VariableDefinitionContext>	getInitialState()	Get initial state of this context, that is variables that are set at the creation of this context not including variables inherited from the parent context.
@NotNull Map<String,VariableDefinitionContext>	getOriginalVariables()	The original state of variables in this context, that is, the state as it was when execution of job (environment) started, created from parent context (if applicable) and explicit 'initial state' of this context.
@Nullable ImmutableVariableContext	getParentContext()	Get parent context.
Iterable<VariableDefinitionContext>	getPasswordVariables()	Get all variables in current context that are considered "password" variables, i.e.
@NotNull Map<String,VariableDefinitionContext>	getResultVariables()

Method Detail

getOriginalVariables

@NotNull
@NotNull Map<String,VariableDefinitionContext> getOriginalVariables()

The original state of variables in this context, that is, the state as it was when execution of job (environment) started, created from parent context (if applicable) and explicit 'initial state' of this context. See also getInitialState()

Returns:

immutable state of the variables as it was when this object was created

getEffectiveVariables

@NotNull
@NotNull Map<String,VariableDefinitionContext> getEffectiveVariables()

Effective state of the variables. This is calculated according to the following rules: - result variables hide variables from original state - local variables hide all other variables

Returns:

immutable map containing effective state of variables in this context

Since:

5.7

getResultVariables

@NotNull
@NotNull Map<String,VariableDefinitionContext> getResultVariables()

Returns:

immutable map containing all result variables in this context

Since:

5.7

getPasswordVariables

Iterable<VariableDefinitionContext> getPasswordVariables()

Get all variables in current context that are considered "password" variables, i.e. contain string "password" in name.

Since:

5.10

getParentContext

@Nullable
@Nullable ImmutableVariableContext getParentContext()

Get parent context. Note that making changes to the parent context is not supported.

Since:

9.4

getInitialState

@NotNull
@NotNull Map<String,VariableDefinitionContext> getInitialState()

Get initial state of this context, that is variables that are set at the creation of this context not including variables inherited from the parent context.