org.trimou.engine.parser

Class Template

java.lang.Object

org.trimou.engine.parser.Template

All Implemented Interfaces:

Identified, Mustache

@Internal
public class Template
extends Object
implements Mustache

A Mustache template.

Author:

Martin Kouba

Constructor Summary

Constructors

Constructor and Description
Template(Long generatedId, String name, MustacheEngine engine)
Template(Long generatedId, String name, MustacheEngine engine, List<Template> nestedTemplates)

Method Summary

Modifier and Type	Method and Description
MustacheEngine	getEngine()
Long	getGeneratedId() The id must be unique for the given component type and MustacheEngine instance.
String	getName() A name is used to locate the template contents by means of TemplateLocator.
Template	getNestedTemplate(String name)
RootSegment	getRootSegment()
void	render(Appendable appendable, Object data) Render the template.
String	render(Object data) Render the template.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Template

public Template(Long generatedId,
                String name,
                MustacheEngine engine)

Parameters:

generatedId -

name -

engine -

Template

public Template(Long generatedId,
                String name,
                MustacheEngine engine,
                List<Template> nestedTemplates)

Parameters:

generatedId -

name -

engine -

nestedTemplates -

Method Detail

getGeneratedId

public Long getGeneratedId()

Description copied from interface: Identified

The id must be unique for the given component type and MustacheEngine instance.

Specified by:

getGeneratedId in interface Identified

Returns:

the generated id

getName

public String getName()

Description copied from interface: Mustache

A name is used to locate the template contents by means of TemplateLocator. It's sometimes referenced as an identifier provided by the user. In most cases, the name represents a full (possibly virtual) path of the template.

Note that it's possible to have more than one template with the same name for a MustacheEngine instance, due to existence of MustacheEngine.compileMustache(String, String).

Specified by:

getName in interface Mustache

Returns:

the template name

See Also:

Identified.getGeneratedId()

render

public String render(Object data)

Description copied from interface: Mustache

Render the template.

Specified by:

render in interface Mustache

Parameters:

data - Optional context object (ideally immutable), may be null

Returns:

the rendered template as string

render

public void render(Appendable appendable,
                   Object data)

Description copied from interface: Mustache

Render the template.

Watch out! Any appendable-specific operations (e.g. stream flushing and closing) are not performed automatically.

Note that if an asynchronous helper is used the "append" operations may be delayed due to the use of an intermediate buffer.

Specified by:

render in interface Mustache

Parameters:

appendable - The appendable to append the rendered template to

data - Optional context object (ideally immutable), may be null

getRootSegment

public RootSegment getRootSegment()

getEngine

public MustacheEngine getEngine()

getNestedTemplate

public Template getNestedTemplate(String name)

toString

public String toString()

Overrides:

toString in class Object