eu.easyrpa.openframework.email.message.templates

Class TextTemplate

java.lang.Object

eu.easyrpa.openframework.email.message.templates.TextTemplate

Direct Known Subclasses:

FreeMarkerTemplate

public abstract class TextTemplate
extends Object

Base class for any textual template.

It keeps all parameters necessary for compilation of the template.

See Also:

FreeMarkerTemplate

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	properties Map with properties that is intended to use for substitution of variables within this template.

Constructor Summary

Constructors

Constructor and Description
TextTemplate(Map<String,Object> props) Constructs a new TextTemplate.

Method Summary

Modifier and Type	Method and Description
abstract String	compile() Compiles this template.
abstract void	compileAndWrite(Writer writer) Compiles this template and writes result using given writer.
TextTemplate	put(Map<String,Object> props) Puts all properties of given map into properties of this template.
TextTemplate	put(String varName, Object value) Puts a new property into properties of this template.

Methods inherited from class java.lang.Object

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

Field Detail

properties

protected Map<String,Object> properties

Map with properties that is intended to use for substitution of variables within this template.

Constructor Detail

TextTemplate

public TextTemplate(Map<String,Object> props)

Constructs a new TextTemplate.

Parameters:

props - the map with properties that is intended to use for substitution of variables within this template.

Method Detail

put

public TextTemplate put(Map<String,Object> props)

Puts all properties of given map into properties of this template.

Parameters:

props - the map with properties to put.

Returns:

this object to allow joining of methods calls into chain.

put

public TextTemplate put(String varName,
                        Object value)

Puts a new property into properties of this template.

Parameters:

varName - the template variable name for which this property defines a value.

value - the actual value that should be used instead of variable during compilation of this template.

Returns:

this object to allow joining of methods calls into chain.

compile

public abstract String compile()

Compiles this template.

Returns:

the string with result of this template compilation using specified properties.

compileAndWrite

public abstract void compileAndWrite(Writer writer)

Compiles this template and writes result using given writer.

Parameters:

writer - the Writer used for writing the result of compilation.