Module org.apache.wicket.util

Package org.apache.wicket.util.string.interpolator

Class MapVariableInterpolator

java.lang.Object

org.apache.wicket.util.string.interpolator.VariableInterpolator

org.apache.wicket.util.string.interpolator.MapVariableInterpolator

All Implemented Interfaces:

Serializable, IClusterable

Direct Known Subclasses:

SystemVariableInterpolator

public class MapVariableInterpolator
extends VariableInterpolator

Interpolates variables into a String from a Map.

Since:

1.2.6

Author:

Jonathan Locke

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.util.string.interpolator.VariableInterpolator

string

Constructor Summary

Constructors

Constructor	Description
MapVariableInterpolator(String string, Map<?,?> variables)	Constructor.
MapVariableInterpolator(String string, Map<?,?> variables, boolean exceptionOnNullVarValue)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected String	getValue(String variableName)	Retrieves a value for a variable name during interpolation.
static String	interpolate(String string, Map<?,?> variables)	Interpolates a String with the arguments defined in the given Map.
final void	setVariables(Map<?,?> variables)	Sets the Map of variables.

Methods inherited from class org.apache.wicket.util.string.interpolator.VariableInterpolator

toString

Methods inherited from class java.lang.Object

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

Constructor Details

MapVariableInterpolator

public MapVariableInterpolator(String string,
 Map<?,?> variables)

Constructor.

Parameters:

string - a String to interpolate into

variables - the variables to substitute

MapVariableInterpolator

public MapVariableInterpolator(String string,
 Map<?,?> variables,
 boolean exceptionOnNullVarValue)

Constructor.

Parameters:

string - a String to interpolate into

variables - the variables to substitute

exceptionOnNullVarValue - if true an IllegalStateException will be thrown if getValue(String) returns null, otherwise the ${varname} string will be left in the String so that multiple interpolators can be chained

Method Details

setVariables

public final void setVariables(Map<?,?> variables)

Sets the Map of variables.

Parameters:

variables - the Map of variables

getValue

protected String getValue(String variableName)

Retrieves a value for a variable name during interpolation.

Specified by:

getValue in class VariableInterpolator

Parameters:

variableName - the variable name

Returns:

the value

interpolate

public static String interpolate(String string,
 Map<?,?> variables)

Interpolates a String with the arguments defined in the given Map.

Parameters:

string - a String to interpolate into

variables - the variables to substitute

Returns:

the interpolated String