org.trimou

Interface Mustache

All Superinterfaces:

Identified

All Known Implementing Classes:

Template

public interface Mustache
extends Identified

A compiled mustache template. Implementation must be thread-safe.

Author:

Martin Kouba

Method Summary

Modifier and Type	Method and Description
String	getName() A name is used to locate the template contents by means of TemplateLocator.
void	render(Appendable appendable, Object data) Render the template.
String	render(Object data) Render the template.

Methods inherited from interface org.trimou.engine.id.Identified

getGeneratedId

Method Detail

getName

String getName()

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).

Returns:

the template name

See Also:

Identified.getGeneratedId()

render

String render(Object data)

Render the template.

Parameters:

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

Returns:

the rendered template as string

render

void render(Appendable appendable,
            Object data)

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.

Parameters:

appendable - The appendable to append the rendered template to

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