Package com.atlassian.bamboo.variable

Class VariableUtils

java.lang.Object

com.atlassian.bamboo.variable.VariableUtils

public class VariableUtils
extends Object

Method Summary

Modifier and Type	Method	Description
static Map<String,VariableDefinition>	buildVariableDefinitionMap(Collection<? extends VariableDefinition> variableDefinitions)	Build map of VariableDefinition.getKey() -> VariableDefinition from a collection of VariableDefinitions
static boolean	containsVariableUsage(@NotNull String text)	Returns true if the given text contains variable usages from any namespace.
static @NotNull List<VariableUsage>	findVariableUsages(@NotNull String text)	Finds all variable usages within a given text.
static Map<String,VariableDefinitionContext>	identifiersToContextMap(@NotNull Iterable<? extends VariableDefinitionIdentifier> ids)
static boolean	isValidSecretVariable(@Nullable String name, @Nullable String decryptedValue)

Methods inherited from class java.lang.Object

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

Method Detail

identifiersToContextMap

public static Map<String,VariableDefinitionContext> identifiersToContextMap(@NotNull
                                                                                  @NotNull Iterable<? extends VariableDefinitionIdentifier> ids)

containsVariableUsage

public static boolean containsVariableUsage(@NotNull
                                            @NotNull String text)

Returns true if the given text contains variable usages from any namespace.

Variable usage consists of variable name, preceded by the namespace (usually "bamboo"), put between "${" and "}".

Example variable usages:

 - ${bamboo.my.custom.variable}
 - ${bamboo.functionalTestOptions}
 - ${system.M2_HOME}
 

Parameters:

text - text to verify

Returns:

true, if text contains variable usages, false otherwise

findVariableUsages

@NotNull
public static @NotNull List<VariableUsage> findVariableUsages(@NotNull
                                                              @NotNull String text)

Finds all variable usages within a given text.

buildVariableDefinitionMap

public static Map<String,VariableDefinition> buildVariableDefinitionMap(Collection<? extends VariableDefinition> variableDefinitions)

Build map of VariableDefinition.getKey() -> VariableDefinition from a collection of VariableDefinitions

isValidSecretVariable

public static boolean isValidSecretVariable(@Nullable
                                            @Nullable String name,
                                            @Nullable
                                            @Nullable String decryptedValue)

Parameters:

name - variable name

decryptedValue - variable value

Returns:

if secret variable is valid, e.g. not multiline