com.atlassian.bamboo.variable

Class CustomVariableContextImpl

java.lang.Object

com.atlassian.bamboo.variable.CustomVariableContextImpl

All Implemented Interfaces:

CustomVariableContext

public class CustomVariableContextImpl
extends Object
implements CustomVariableContext

Constructor Summary

Constructors

Constructor and Description
CustomVariableContextImpl(VariableSubstitutorFactory variableSubstitutorFactory)

Method Summary

Modifier and Type	Method and Description
void	addCustomData(String key, String value) Adds a VariableType.MANUAL variable to ThreadLocal state.
void	clearContext() Clear ThreadLocal state.
@NotNull Set<String>	findAllVariables(@Nullable String variable) Given a string, and a Map of variables (variable -> value), all patterns in the string array matching ${bamboo.<variable>} will be substituted with the value.
Map<String,VariableDefinitionContext>	getBuildInRepositoryVariablesIfBuildContext() Return variables all built-in variables produced by repository plugin for the current build context.
@NotNull Map<String,VariableSubstitutionContext>	getSubstitutedVariables() Get all the variables that have previously been substituted in this thread.
@NotNull Map<String,VariableDefinitionContext>	getVariableContexts() Get all variables from current thread local context.
@NotNull VariableSubstitutorFactory	getVariableSubstitutorFactory()
@NotNull String	removeAllVariables(@NotNull String value) Given a string array, remove all variable patterns.
void	setPlan(@NotNull ImmutablePlan plan) Sets Plan reference and default variable definitions (globals and from plan) in ThreadLocal state.
String	substituteString(String value) Substitutes variables in the input string with their values using data from existing ThreadLocal state.
<V,E1 extends Exception,E2 extends Exception,E3 extends Exception> V	withVariableSubstitutor(@NotNull VariableSubstitutor variableSubstitutor, BambooCallables.ThrowingX<V,E1,E2,E3> callable) Run operation with provided VariableSubstitutor in thread local context.
<V> V	withVariableSubstitutor(@NotNull VariableSubstitutor variableSubstitutor, @NotNull Callable<V> callable) Run operation with provided VariableSubstitutor in thread local context.
void	withVariableSubstitutor(@NotNull VariableSubstitutor variableSubstitutor, @NotNull Runnable runnable) Run operation with provided VariableSubstitutor in thread local context.
<V> V	withVariableSubstitutor(@NotNull VariableSubstitutor variableSubstitutor, @NotNull Supplier<V> supplier) Run operation with provided VariableSubstitutor in thread local context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CustomVariableContextImpl

public CustomVariableContextImpl(VariableSubstitutorFactory variableSubstitutorFactory)

Method Detail

getSubstitutedVariables

@NotNull
public @NotNull Map<String,VariableSubstitutionContext> getSubstitutedVariables()

Description copied from interface: CustomVariableContext

Get all the variables that have previously been substituted in this thread.

Specified by:

getSubstitutedVariables in interface CustomVariableContext

Returns:

addCustomData

public void addCustomData(String key,
                          String value)

Description copied from interface: CustomVariableContext

Adds a VariableType.MANUAL variable to ThreadLocal state.

Specified by:

addCustomData in interface CustomVariableContext

Parameters:

key - name of the variable

value - value of the variable

substituteString

public String substituteString(String value)

Description copied from interface: CustomVariableContext

Substitutes variables in the input string with their values using data from existing ThreadLocal state.

Specified by:

substituteString in interface CustomVariableContext

Parameters:

value - input string

Returns:

substituted string

setPlan

public void setPlan(@NotNull
                    @NotNull ImmutablePlan plan)

Description copied from interface: CustomVariableContext

Sets Plan reference and default variable definitions (globals and from plan) in ThreadLocal state. Clears history of substituted variables (CustomVariableContext.getSubstitutedVariables()

Specified by:

setPlan in interface CustomVariableContext

clearContext

public void clearContext()

Description copied from interface: CustomVariableContext

Clear ThreadLocal state.

Specified by:

clearContext in interface CustomVariableContext

removeAllVariables

@NotNull
public @NotNull String removeAllVariables(@NotNull
                                                   @NotNull String value)

Given a string array, remove all variable patterns.

Specified by:

removeAllVariables in interface CustomVariableContext

Parameters:

value - string values to be analyzed

Returns:

value with variables removed

findAllVariables

@NotNull
public @NotNull Set<String> findAllVariables(@Nullable
                                                      @Nullable String variable)

Given a string, and a Map of variables (variable -> value), all patterns in the string array matching ${bamboo.<variable>} will be substituted with the value.

Specified by:

findAllVariables in interface CustomVariableContext

Parameters:

variable - String value to be analyzed

Returns:

Array of string values with variables extrapolated

getVariableContexts

@NotNull
public @NotNull Map<String,VariableDefinitionContext> getVariableContexts()

Description copied from interface: CustomVariableContext

Get all variables from current thread local context.

Specified by:

getVariableContexts in interface CustomVariableContext

Returns:

mapping between variable keys and contexts

getBuildInRepositoryVariablesIfBuildContext

public Map<String,VariableDefinitionContext> getBuildInRepositoryVariablesIfBuildContext()

Description copied from interface: CustomVariableContext

Return variables all built-in variables produced by repository plugin for the current build context. Current thread local state must contain BuildContext, otherwise returned map will be empty. Note: variables are used in repository definition, they will be resolved according to current state of the CustomVariableContext

Specified by:

getBuildInRepositoryVariablesIfBuildContext in interface CustomVariableContext

getVariableSubstitutorFactory

@NotNull
public @NotNull VariableSubstitutorFactory getVariableSubstitutorFactory()

Specified by:

getVariableSubstitutorFactory in interface CustomVariableContext

Returns:

factory for VariableSubstitutor

withVariableSubstitutor

public void withVariableSubstitutor(@NotNull
                                    @NotNull VariableSubstitutor variableSubstitutor,
                                    @NotNull
                                    @NotNull Runnable runnable)

Description copied from interface: CustomVariableContext

Run operation with provided VariableSubstitutor in thread local context. Restore current thread local state when finished.

Specified by:

withVariableSubstitutor in interface CustomVariableContext

withVariableSubstitutor

public <V> V withVariableSubstitutor(@NotNull
                                     @NotNull VariableSubstitutor variableSubstitutor,
                                     @NotNull
                                     @NotNull Callable<V> callable)
                              throws Exception

Description copied from interface: CustomVariableContext

Run operation with provided VariableSubstitutor in thread local context. Restore current thread local state when finished.

Specified by:

withVariableSubstitutor in interface CustomVariableContext

Throws:

Exception

withVariableSubstitutor

public <V> V withVariableSubstitutor(@NotNull
                                     @NotNull VariableSubstitutor variableSubstitutor,
                                     @NotNull
                                     @NotNull Supplier<V> supplier)

Description copied from interface: CustomVariableContext

Run operation with provided VariableSubstitutor in thread local context. Restore current thread local state when finished.

Specified by:

withVariableSubstitutor in interface CustomVariableContext

withVariableSubstitutor

public <V,E1 extends Exception,E2 extends Exception,E3 extends Exception> V withVariableSubstitutor(@NotNull
                                                                                                    @NotNull VariableSubstitutor variableSubstitutor,
                                                                                                    @NotNull
                                                                                                    BambooCallables.ThrowingX<V,E1,E2,E3> callable)
                                                                                             throws E1 extends Exception,
                                                                                                    E2 extends Exception,
                                                                                                    E3 extends Exception

Description copied from interface: CustomVariableContext

Run operation with provided VariableSubstitutor in thread local context. Restore current thread local state when finished.

Specified by:

withVariableSubstitutor in interface CustomVariableContext

Throws:

E1 extends Exception