com.github.jknack.handlebars.helper

Class BlockHelper

java.lang.Object

com.github.jknack.handlebars.helper.BlockHelper

All Implemented Interfaces:

Helper<java.lang.Object>

public class BlockHelper
extends java.lang.Object
implements Helper<java.lang.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 and Description
static Helper<java.lang.Object>	INSTANCE A singleton instance of this helper.
static java.lang.String	NAME The helper's name.

Constructor Summary

Constructors

Constructor and Description
BlockHelper()

Method Summary

Modifier and Type	Method and Description
java.lang.CharSequence	apply(java.lang.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 Detail

INSTANCE

public static final Helper<java.lang.Object> INSTANCE

A singleton instance of this helper.

NAME

public static final java.lang.String NAME

The helper's name.

See Also:

Constant Field Values

Constructor Detail

BlockHelper

public BlockHelper()

Method Detail

apply

public java.lang.CharSequence apply(java.lang.Object context,
                                    Options options)
                             throws java.io.IOException

Description copied from interface: Helper

Apply the helper to the context.

Specified by:

apply in interface Helper<java.lang.Object>

Parameters:

context - The context object.

options - The options object.

Returns:

A string result.

Throws:

java.io.IOException - If a template cannot be loaded.