de.aristaflow.adept2.util

Class VariableReplacer

java.lang.Object

de.aristaflow.adept2.util.VariableReplacer

public class VariableReplacer
extends java.lang.Object

Tool class to find and replace variables of the form ${variable}. Example code:

 VariableReplacer varrep = new VariableReplacer("a ${var} string");
 while (varrep.findNext())
 {
   ...
   String var = varrep.getVariable();
   ...
   varrep.replaceWith("short");
   ...
 }
 varrep.getResult()
 

Author:

Patrick Schmidt

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.regex.Pattern	VAR_PATTERN the regular expression pattern used to find the variables

Constructor Summary

Constructors

Constructor and Description
VariableReplacer(java.lang.String string) Constructs a new VariableReplacer.

Method Summary

Modifier and Type	Method and Description
boolean	findNext() Finds the next variable.
java.lang.String	getResult() Returns the string after replacing the variables.
java.lang.String	getVariable() Returns the current variable name.
static java.lang.String	replace(java.lang.String string, java.util.Map<java.lang.String,java.lang.String> values) Replaces all variables with the values provided in the map.
static java.lang.String	replace(java.lang.String string, java.util.Map<java.lang.String,java.lang.String> values, boolean exceptionOnMissing) Replaces all variables with the values provided in the map.
void	replaceWith(java.lang.String value) Replace the current variable with the given value.

Methods inherited from class java.lang.Object

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

Field Detail

VAR_PATTERN

public static final java.util.regex.Pattern VAR_PATTERN

the regular expression pattern used to find the variables

Constructor Detail

VariableReplacer

public VariableReplacer(java.lang.String string)

Constructs a new VariableReplacer.

Parameters:

string - the string to be parsed

Method Detail

findNext

public boolean findNext()

Finds the next variable.

Returns:

if a next variable was found

getVariable

public java.lang.String getVariable()

Returns the current variable name. May be called after findNext() has returned true.

Returns:

the current variable name

replaceWith

public void replaceWith(java.lang.String value)

Replace the current variable with the given value. Calling this method is optional, i.e. not every variable must be replaced.

Parameters:

value - the value to replace the current variable with

getResult

public java.lang.String getResult()

Returns the string after replacing the variables.

Returns:

the string after replacing the variables

replace

public static java.lang.String replace(java.lang.String string,
                                       java.util.Map<java.lang.String,java.lang.String> values)

Replaces all variables with the values provided in the map. Missing values will be ignored.

Parameters:

string - the string containing the variables

values - the values to replace the variables with

Returns:

the result of the replacement

replace

public static java.lang.String replace(java.lang.String string,
                                       java.util.Map<java.lang.String,java.lang.String> values,
                                       boolean exceptionOnMissing)

Replaces all variables with the values provided in the map. Missing values can optionally be ignored or lead to an exception.

Parameters:

string - the string containing the variables

values - the values to replace the variables with

exceptionOnMissing - whether a missing value for a variable should lead to an exception

Returns:

the result of the replacement

Throws:

java.util.MissingResourceException - if exceptionOnMissing is true and the value for an encountered variable is missing from the map