Package com.atlassian.bamboo.variable.substitutor

Interface VariableSubstitutorFactory

All Known Implementing Classes:

VariableSubstitutorFactoryImpl

public interface VariableSubstitutorFactory

Bean creating instances of VariableSubstitutor for various contexts.

Method Summary

Modifier and Type	Method	Description
@NotNull VariableSubstitutor	newSubstitutorForCommonContext(@NotNull CommonContext commonContext)
@NotNull VariableSubstitutor	newSubstitutorForCommonContextWithLocalVariableContext(@NotNull CommonContext commonContext)	Creates a substitutor with a local copy of the variable context coming from the context.
@NotNull VariableSubstitutor	newSubstitutorForDeploymentResult(long deploymentResultId)
@NotNull VariableSubstitutor	newSubstitutorForGlobalContext()
@NotNull VariableSubstitutor	newSubstitutorForPlan(@NotNull ImmutablePlan plan)
@NotNull VariableSubstitutor	newSubstitutorForVariables(@NotNull Map<String,VariableDefinitionContext> variablesContextMap)

Method Detail

newSubstitutorForGlobalContext

@NotNull
@NotNull VariableSubstitutor newSubstitutorForGlobalContext()

Returns:

variable substitutor initiated with known global variables

newSubstitutorForPlan

@NotNull
@NotNull VariableSubstitutor newSubstitutorForPlan(@NotNull
                                                   @NotNull ImmutablePlan plan)

Returns:

variable substitutor initiated with known global and plan variables

newSubstitutorForCommonContext

@NotNull
@NotNull VariableSubstitutor newSubstitutorForCommonContext(@NotNull
                                                            @NotNull CommonContext commonContext)

Parameters:

commonContext -

Returns:

variable substitutor initiated with global, plan and build/deployment context variables (including result-scoped variables, automatically generated variables, etc.)

newSubstitutorForCommonContextWithLocalVariableContext

@NotNull
@NotNull VariableSubstitutor newSubstitutorForCommonContextWithLocalVariableContext(@NotNull
                                                                                    @NotNull CommonContext commonContext)

Creates a substitutor with a local copy of the variable context coming from the context. This enables calling code to modify content of the VariableContext safely, without affecting the original.

Parameters:

commonContext -

Returns:

variable substitutor initiated with global, plan and build/deployment context variables (including result-scoped variables, automatically generated variables, etc.)

Since:

12.0

newSubstitutorForVariables

@NotNull
@NotNull VariableSubstitutor newSubstitutorForVariables(@NotNull
                                                        @NotNull Map<String,VariableDefinitionContext> variablesContextMap)

Returns:

variable substitutor initiated with variables as argument

newSubstitutorForDeploymentResult

@NotNull
@NotNull VariableSubstitutor newSubstitutorForDeploymentResult(long deploymentResultId)

Returns:

variable substitutor initiated with variables from deployment result