eu.easyrpa.openframework.email.message.templates

Class FreeMarkerTemplate

java.lang.Object

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

eu.easyrpa.openframework.email.message.templates.FreeMarkerTemplate

public class FreeMarkerTemplate
extends TextTemplate

Represents a textual template based on FreeMarker template language.

Field Summary

Fields inherited from class eu.easyrpa.openframework.email.message.templates.TextTemplate

properties

Constructor Summary

Constructors

Constructor and Description
FreeMarkerTemplate(InputStream inputStream) Constructs a new FreeMarkerTemplate with given template text.
FreeMarkerTemplate(InputStream inputStream, String charsetName) Constructs a new FreeMarkerTemplate with given template text.
FreeMarkerTemplate(String templateText, Map<String,Object> map) Constructs a new FreeMarkerTemplate with given template text.

Method Summary

Modifier and Type	Method and Description
String	compile() Compiles this template.
void	compileAndWrite(Writer writer) Compiles this template and writes result using given writer.

Methods inherited from class eu.easyrpa.openframework.email.message.templates.TextTemplate

put, put

Methods inherited from class java.lang.Object

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

Constructor Detail

FreeMarkerTemplate

public FreeMarkerTemplate(InputStream inputStream)
                   throws IOException

Constructs a new FreeMarkerTemplate with given template text.

Parameters:

inputStream - the InputStream that provides template text on FreeMarker template language with UTF-8 charset.

Throws:

IOException - in case of some errors during reading and parsing of given template text.

FreeMarkerTemplate

public FreeMarkerTemplate(InputStream inputStream,
                          String charsetName)
                   throws IOException

Constructs a new FreeMarkerTemplate with given template text.

Parameters:

inputStream - the InputStream that provides template text on FreeMarker template language.

charsetName - the name of template text charset.

Throws:

IOException - in case of some errors during reading and parsing of given template text.

FreeMarkerTemplate

public FreeMarkerTemplate(String templateText,
                          Map<String,Object> map)
                   throws IOException

Constructs a new FreeMarkerTemplate with given template text.

Parameters:

templateText - the string with template text on FreeMarker template language.

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

Throws:

IOException - in case of some errors during reading and parsing of given template text.

Method Detail

compile

public String compile()

Compiles this template.

Specified by:

compile in class TextTemplate

Returns:

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

compileAndWrite

public void compileAndWrite(Writer writer)

Compiles this template and writes result using given writer.

Specified by:

compileAndWrite in class TextTemplate

Parameters:

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