com.github.mustachejava

Interface Mustache

All Superinterfaces:

Code

All Known Implementing Classes:

DefaultMustache

public interface Mustache
extends Code

The interface to Mustache objects

Method Summary

Methods

Modifier and Type	Method and Description
void	append(java.lang.String text) Append text to the mustache output.
java.lang.Object	clone() Deep clone of the mustache object.
java.io.Writer	execute(java.io.Writer writer, java.lang.Object scope) Execute the mustache object with a given writer and a single scope context.
java.io.Writer	execute(java.io.Writer writer, java.lang.Object[] scopes) Execute the mustache with a given writer and an array of scope objects.
Code[]	getCodes() Get the underlying code objects.
void	identity(java.io.Writer writer) Execute the mustache to output itself.
void	init() Initialize the mustache before executing.
java.io.Writer	run(java.io.Writer writer, java.lang.Object[] scopes) Only executes the codes.
void	setCodes(Code[] codes) Change the underlying codes of the mustache implementation.

Method Detail

append

void append(java.lang.String text)

Append text to the mustache output.

Specified by:

append in interface Code

Parameters:

text -

clone

java.lang.Object clone()

Deep clone of the mustache object.

Specified by:

clone in interface Code

Returns:

execute

java.io.Writer execute(java.io.Writer writer,
                     java.lang.Object scope)

Execute the mustache object with a given writer and a single scope context.

Specified by:

execute in interface Code

Parameters:

writer -

scope -

Returns:

execute

java.io.Writer execute(java.io.Writer writer,
                     java.lang.Object[] scopes)

Execute the mustache with a given writer and an array of scope objects. The scopes are searched right-to-left for references.

Specified by:

execute in interface Code

Parameters:

writer -

scopes -

Returns:

getCodes

Code[] getCodes()

Get the underlying code objects.

Specified by:

getCodes in interface Code

Returns:

identity

void identity(java.io.Writer writer)

Execute the mustache to output itself.

Specified by:

identity in interface Code

Parameters:

writer -

init

void init()

Initialize the mustache before executing. This is must be called at least once and is normally called already by the time you have a mustache instance.

Specified by:

init in interface Code

setCodes

void setCodes(Code[] codes)

Change the underlying codes of the mustache implementation.

Specified by:

setCodes in interface Code

Parameters:

codes -

run

java.io.Writer run(java.io.Writer writer,
                 java.lang.Object[] scopes)

Only executes the codes. Does not append the text.

Parameters:

writer -

scopes -

Returns: