org.ow2.proactive.scheduler.common.util

Class VariableSubstitutor

java.lang.Object

org.ow2.proactive.scheduler.common.util.VariableSubstitutor

public class VariableSubstitutor
extends Object

Utility class which facilitates the filtering of variables defined in strings and scripts by using a variable map. These variables should have ${...} or $... format. They will be replace with corresponding values specified in the variable map.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUBSITUTE_PREFIX
static String	SUBSITUTE_PREFIX_SIMPLE
static String	SUBSTITUTE_SUFFIX

Method Summary

Modifier and Type	Method and Description
static StrSubstitutor	buildSubstitutor(Map<? extends Serializable,? extends Serializable> variables)
static Map<String,String>	filterAndUpdate(Map<String,String> input, Map<String,? extends Serializable> variables) Replaces variables in input map values using keys defined in variables map.
static void	filterAndUpdate(Script<?> script, Map<? extends Serializable,? extends Serializable> variables) Filters the specified script object.
static String	filterAndUpdate(String input, Map<? extends Serializable,? extends Serializable> variables) Filters the specified string and replaces the variables with values specified in the map.
static Map<String,Serializable>	resolveVariables(Map<String,Serializable> variables, Map<String,Serializable> dictionary) Creates a HashMap with variablesDictionary where values are resolved.

Methods inherited from class java.lang.Object

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

Field Detail

SUBSITUTE_PREFIX

public static final String SUBSITUTE_PREFIX

See Also:

Constant Field Values

SUBSITUTE_PREFIX_SIMPLE

public static final String SUBSITUTE_PREFIX_SIMPLE

See Also:

Constant Field Values

SUBSTITUTE_SUFFIX

public static final String SUBSTITUTE_SUFFIX

See Also:

Constant Field Values

Method Detail

filterAndUpdate

public static Map<String,String> filterAndUpdate(Map<String,String> input,
                                                 Map<String,? extends Serializable> variables)

Replaces variables in input map values using keys defined in variables map.

Parameters:

input - a map that may contain values to replace.

variables - a map which contains variable name and value pairs.

resolveVariables

public static Map<String,Serializable> resolveVariables(Map<String,Serializable> variables,
                                                        Map<String,Serializable> dictionary)

Creates a HashMap with variablesDictionary where values are resolved. Solve variables value if bound to another variable, for instance "var log=${LOG_ENV_VAR}", we expect that LOG_ENV_VAR is replaced by its value. To do so we have a variables hash, that must have all references and then for each variable we do a filterAndUpdate that will recursively replace when needed, @see VariableSubstitutor. Some limitations to consider: recursive substitution limit is VariableSubstitutor.MAXIMUM_DEPTH, if the variable value is a complex data structure (array, List, Vector) we will not substitute it.

Parameters:

variables - input hash containing variables and their values may reference other variables

Returns:

dictionary with the same variables however with their values resolved

filterAndUpdate

public static String filterAndUpdate(String input,
                                     Map<? extends Serializable,? extends Serializable> variables)

Filters the specified string and replaces the variables with values specified in the map.

Parameters:

input - the string which need to be filtered

variables - a map which contains variable values

Returns:

the filtered string

See Also:

filterAndUpdate(String, Map)

filterAndUpdate

public static void filterAndUpdate(Script<?> script,
                                   Map<? extends Serializable,? extends Serializable> variables)

Filters the specified script object. It replaces the variables in the script content and parameter array with the values specified in the variable map.

Parameters:

script - the script to filter

variables - a map which contains variables values

buildSubstitutor

public static StrSubstitutor buildSubstitutor(Map<? extends Serializable,? extends Serializable> variables)