Package com.github.jknack.handlebars.helper

Class BlockHelper

java.lang.Object

com.github.jknack.handlebars.helper.BlockHelper

All Implemented Interfaces:

Helper<Object>

public class BlockHelper
extends Object
implements Helper<Object>

The block helper will replace its section with the partial of the same name if it exists.

If delete-after-merge is set to true, the partial will be delete once applied it.

  {{block "title" [delete-after-merge=false]}}
 

Since:

0.3.0

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
BlockHelper()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

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 Details

BlockHelper

public BlockHelper()

Method Details

apply

public Object 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.