com.atlassian.bamboo.build
Interface VariableSubstitutionBean

All Known Implementing Classes:

VariableSubstitutionBeanImpl

public interface VariableSubstitutionBean

Method Summary

java.util.Map<java.lang.String,java.lang.String>	getVariables(BuildContext buildContext)
java.lang.String	removeAllVariables(java.lang.String unparsedString) Remove all variables from unparsedString
java.lang.String	substituteBambooVariables(java.lang.String stringWithValuesToSubstitute) Takes a String to be parsed for variable references and substitutes with the variable values then returns the substituted string.
java.lang.String[]	substituteBambooVariables(java.lang.String[] stringWithValuesToSubstitute, BuildContext buildContext, BuildLogger buildLogger) Takes an array of Strings to be parsed for variable references and substitutes with the variable values then returns the substituted string If BuildContext is null only global variables, system variables and capabilities will be substituted.
java.lang.String	substituteBambooVariables(java.lang.String stringWithValuesToSubstitute, BuildContext buildContext, BuildLogger buildLogger) Takes a String to be parsed for variable references and substitutes with the variable values then returns the substituted string.

Method Detail

substituteBambooVariables

@Nullable
java.lang.String substituteBambooVariables(@Nullable
                                                    java.lang.String stringWithValuesToSubstitute)

Takes a String to be parsed for variable references and substitutes with the variable values then returns the substituted string. Only global variables, system variables and capabilities will be substituted.

Parameters:

stringWithValuesToSubstitute - - to substitute

Returns:

string

substituteBambooVariables

java.lang.String substituteBambooVariables(@Nullable
                                           java.lang.String stringWithValuesToSubstitute,
                                           @Nullable
                                           BuildContext buildContext,
                                           @Nullable
                                           BuildLogger buildLogger)

Takes a String to be parsed for variable references and substitutes with the variable values then returns the substituted string. If BuildContext is null only global variables, system variables and capabilities will be substituted.

Parameters:

stringWithValuesToSubstitute - - to substitute

buildContext - - associated with the command line

buildLogger - - for logging messages to get logged to.

Returns:

string

substituteBambooVariables

java.lang.String[] substituteBambooVariables(java.lang.String[] stringWithValuesToSubstitute,
                                             @Nullable
                                             BuildContext buildContext,
                                             @Nullable
                                             BuildLogger buildLogger)

Takes an array of Strings to be parsed for variable references and substitutes with the variable values then returns the substituted string If BuildContext is null only global variables, system variables and capabilities will be substituted.

Parameters:

stringWithValuesToSubstitute - - to substitute

buildContext -

buildLogger -

Returns:

string

getVariables

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

removeAllVariables

java.lang.String removeAllVariables(@NotNull
                                    java.lang.String unparsedString)

Remove all variables from unparsedString

Parameters:

unparsedString -

Returns: