Package org.openstreetmap.josm.tools.template_engine

Class Variable

java.lang.Object

org.openstreetmap.josm.tools.template_engine.Variable

All Implemented Interfaces:

TemplateEntry

public class Variable
extends java.lang.Object
implements TemplateEntry

TemplateEntry that inserts the value of a variable.

Variables starting with "special:" form a separate namespace and provide actions other than simple key-value lookup.

A variable with no mapping for a given data provider will be considered not "valid" (see TemplateEntry.isValid(TemplateEngineDataProvider)).

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	special
private static java.lang.String	SPECIAL_VALUE_EVERYTHING
private static java.lang.String	SPECIAL_VARIABLE_PREFIX
private java.lang.String	variableName

Constructor Summary

Constructors

Constructor	Description
Variable(java.lang.String variableName)	Constructs a new Variable.

Method Summary

Modifier and Type	Method	Description
void	appendText(java.lang.StringBuilder result, TemplateEngineDataProvider dataProvider)	Execute this template by generating text for a given data provider.
boolean	equals(java.lang.Object obj)
int	hashCode()
boolean	isSpecial()	Check if this variable is special.
boolean	isValid(TemplateEngineDataProvider dataProvider)	Check if this template is applicable to the given data provider.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openstreetmap.josm.tools.template_engine.TemplateEntry

getText

Field Detail

SPECIAL_VARIABLE_PREFIX

private static final java.lang.String SPECIAL_VARIABLE_PREFIX

See Also:

Constant Field Values

SPECIAL_VALUE_EVERYTHING

private static final java.lang.String SPECIAL_VALUE_EVERYTHING

See Also:

Constant Field Values

variableName

private final java.lang.String variableName

special

private final boolean special

Constructor Detail

Variable

public Variable(java.lang.String variableName)

Constructs a new Variable.

Parameters:

variableName - the variable name (i.e. the key in the data provider key-value mapping); will be considered "special" if the variable name starts with SPECIAL_VARIABLE_PREFIX

Method Detail

appendText

public void appendText(java.lang.StringBuilder result,
                       TemplateEngineDataProvider dataProvider)

Description copied from interface: TemplateEntry

Execute this template by generating text for a given data provider.

Specified by:

appendText in interface TemplateEntry

Parameters:

result - the StringBuilder to append the text to

dataProvider - the data provider from which information should be compiled to a string

isValid

public boolean isValid(TemplateEngineDataProvider dataProvider)

Description copied from interface: TemplateEntry

Check if this template is applicable to the given data provider.

Specified by:

isValid in interface TemplateEntry

Parameters:

dataProvider - the data provider to check

Returns:

true if all conditions are fulfilled to apply the template (for instance all required key=value mappings are present), false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isSpecial

public boolean isSpecial()

Check if this variable is special.

Returns:

true if this variable is special

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object