com.atlassian.bamboo.variable.substitutor

Interface VariableSubstitutorFactory

public interface VariableSubstitutorFactory

Bean creating instances of VariableSubstitutor for various contexts.

Method Summary

Methods

Modifier and Type	Method and Description
VariableSubstitutor	newSubstitutorForCommonContext(CommonContext commonContext)
VariableSubstitutor	newSubstitutorForGlobalContext()
VariableSubstitutor	newSubstitutorForPlan(ImmutablePlan planIdentifier)
VariableSubstitutor	newSubstitutorForVariables(Map<String,VariableDefinitionContext> variablesContextMap)

Method Detail

newSubstitutorForGlobalContext

@NotNull
VariableSubstitutor newSubstitutorForGlobalContext()

Returns:

variable substitutor initiated with known global variables

newSubstitutorForPlan

@NotNull
VariableSubstitutor newSubstitutorForPlan(@NotNull
                                                ImmutablePlan planIdentifier)

Returns:

variable substitutor initiated with known global & plan variables

newSubstitutorForCommonContext

@NotNull
VariableSubstitutor newSubstitutorForCommonContext(@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.)

newSubstitutorForVariables

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

Returns:

variable substitutor initiated with variables as argument