com.github.jknack.handlebars.helper

Class EachHelper

java.lang.Object

com.github.jknack.handlebars.helper.EachHelper

All Implemented Interfaces:

Helper<Object>

public class EachHelper
extends Object
implements Helper<Object>

You can iterate over a list using the built-in each helper. Inside the block, you can use this to reference the element being iterated over.

Since:

0.3.0

Author:

edgar.espina

Field Summary

Fields

Modifier and Type	Field and Description
static Helper<Object>	INSTANCE A singleton instance of this helper.
static String	NAME The helper's name.

Constructor Summary

Constructors

Constructor and Description
EachHelper()

Method Summary

Methods

Modifier and Type	Method and Description
CharSequence	apply(Object context, Options options) Apply the helper to the context.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final Helper<Object> INSTANCE

A singleton instance of this helper.

NAME

public static final String NAME

The helper's name.

See Also:

Constant Field Values

Constructor Detail

EachHelper

public EachHelper()

Method Detail

apply

public CharSequence apply(Object context,
                 Options options)
                   throws IOException

Description copied from interface: Helper

Apply the helper to the context.

Specified by:

apply in interface Helper<Object>

Parameters:

context - The context object.

options - The options object.

Returns:

A string result.

Throws:

IOException - If a template cannot be loaded.