org.trimou.handlebars

Interface Options

All Superinterfaces:

HelperDefinition

public interface Options
extends HelperDefinition

This objects represents a helper execution context. A new instance is created for every execution. It is not thread-safe.

Since:

1.5

Author:

Martin Kouba

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Options.HelperExecutable A helper task to be executed asynchronously.

Nested classes/interfaces inherited from interface org.trimou.handlebars.HelperDefinition

HelperDefinition.ValuePlaceholder

Method Summary

Modifier and Type	Method and Description
void	append(CharSequence sequence) Append the given sequence to the rendered template.
void	executeAsync(Options.HelperExecutable executable) Executes the given Options.HelperExecutable asynchronously.
void	fn() Proceed with template execution, i.e. execute the block.
void	fn(Appendable appendable) Proceed with execution, i.e. execute the block.
Appendable	getAppendable() In most cases it's better to use the convenient method append(CharSequence) instead.
HelperDefinition	getOriginalDefinition()
Object	getValue(String key) The key is first processed by the KeySplitter and then processed by the resolver chain.
void	partial(String name) Render the template with the current context and append the result to the rendered template.
void	partial(String templateId, Appendable appendable) Render the template with the current context and append the result to the given appendable.
Object	peek() Returns the object at the top of the context stack without removing it.
Object	pop() Removes the object at the top of the context stack and returns that object.
void	push(Object contextObject) Push the specified object on the context stack.
String	source(String name)

Methods inherited from interface org.trimou.handlebars.HelperDefinition

getContentLiteralBlock, getHash, getParameter, getParameters, getTagInfo

Method Detail

append

void append(CharSequence sequence)

Append the given sequence to the rendered template. The seqence is not modified in any way.

Parameters:

sequence -

fn

void fn()

Proceed with template execution, i.e. execute the block. This is no-op for variable tag helpers.

partial

void partial(String name)

Render the template with the current context and append the result to the rendered template.

Parameters:

name -

Throws:

MustacheException - If there's no such template

See Also:

Mustache.getName()

source

String source(String name)

Parameters:

name -

Returns:

the source of the mustache template

Throws:

MustacheException - If there's no such template

Since:

1.6

See Also:

Mustache.getName()

push

void push(Object contextObject)

Push the specified object on the context stack. Helper should pop all pushed objects at the end of its execution. Otherwise all remaining objects will be removed automatically.

Parameters:

contextObject -

pop

Object pop()

Removes the object at the top of the context stack and returns that object.

Returns:

the object at the top of the context stack

Throws:

MustacheException - In case of a helper tries to pop a context object it did not push previously

peek

Object peek()

Returns the object at the top of the context stack without removing it.

Returns:

the object at the top of the context stack

Since:

1.6

getAppendable

Appendable getAppendable()

In most cases it's better to use the convenient method append(CharSequence) instead.

Returns:

The appendable to append the rendered template to

Since:

1.7

See Also:

Mustache.render(Appendable, Object)

fn

void fn(Appendable appendable)

Proceed with execution, i.e. execute the block. This is no-op for variable tag helpers.

Parameters:

appendable - The appendable to append the rendered block to

Since:

1.7

getValue

Object getValue(String key)

The key is first processed by the KeySplitter and then processed by the resolver chain.

Parameters:

key -

Returns:

the value from the context for the given key, or null if no such value exists

Since:

1.8

See Also:

KeySplitter

partial

void partial(String templateId,
             Appendable appendable)

Render the template with the current context and append the result to the given appendable.

Parameters:

templateId -

Throws:

MustacheException - If there's no such template

Since:

1.8

executeAsync

void executeAsync(Options.HelperExecutable executable)

Executes the given Options.HelperExecutable asynchronously.

Parameters:

executable -

Since:

1.8

getOriginalDefinition

HelperDefinition getOriginalDefinition()

Returns:

the original helper definition whose params and hash map may contain value placeholders

Since:

2.3