Package org.openstreetmap.josm.tools.template_engine

Class CompoundTemplateEntry

java.lang.Object

org.openstreetmap.josm.tools.template_engine.CompoundTemplateEntry

All Implemented Interfaces:

TemplateEntry

public final class CompoundTemplateEntry
extends java.lang.Object
implements TemplateEntry

TemplateEntry that concatenates several templates.

Field Summary

Fields

Modifier and Type	Field	Description
private TemplateEntry[]	entries

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CompoundTemplateEntry(TemplateEntry... entries)

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)
static TemplateEntry	fromArray(TemplateEntry... entries)	Factory method to concatenate several TemplateEntrys.
int	hashCode()
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

entries

private final TemplateEntry[] entries

Constructor Detail

CompoundTemplateEntry

private CompoundTemplateEntry(TemplateEntry... entries)

Method Detail

fromArray

public static TemplateEntry fromArray(TemplateEntry... entries)

Factory method to concatenate several TemplateEntrys. If the number of entries is 0 or 1, the result may not be a CompoundTemplateEntry, but optimized to a static text or the single entry itself.

Parameters:

entries - the TemplateEntrys to concatenate

Returns:

a TemplateEntry that concatenates all the entries

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

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