public class VariableConverter extends Object implements ValueConverter
VariableSetter
annotation. The input string will be scanned for
parts that match $VARIABLE$
and have that part
replaced by the actual value of a defined variable. Undefined
variables are not replaced. See setVariable(String, String)
for more details.
Web client note! The web client application defines the variables
ROOT
and HOME
which are the paths to
the web application root directory (/base2
) and the
home directory (/base2/extensions/xxxx
) of the current
extension. This means that the XML configuration file may
contain values like $ROOT$/images/copy.png
. The
$ROOT$
portion will automatically be replaced with the
correct path if the factory method is annotated with the VariableSetter
annotation.
Modifier and Type | Field and Description |
---|---|
private static Pattern |
VARIABLE |
private Map<String,String> |
variables |
Constructor and Description |
---|
VariableConverter()
Create a new variable converter.
|
Modifier and Type | Method and Description |
---|---|
String |
convert(String in,
Method method)
Convert a value.
|
String |
getVariable(String name)
Get the value of a variable.
|
void |
setVariable(String name,
String value)
Set the value of a variable.
|
private static final Pattern VARIABLE
public VariableConverter()
setVariable(String, String)
to define variables and XmlLoader.addValueConverter(ValueConverter)
to register this converter with an XML loader.public String convert(String in, Method method)
ValueConverter
convert
in interface ValueConverter
in
- The value to convertmethod
- The factory setter methodpublic void setVariable(String name, String value)
ActionFactory
or RendererFactory
) is annotated with the
VariableSetter
annotation the
XML loader will scan the value from the XML file for replacement
tags, $VARIABLE$
, and replace the tag with the value
of the variable. If the variable doesn't exists, the tag is left
untouched.name
- The name of the variablevalue
- The value of the variable, or null to remove
the variable