com.github.jknack.handlebars.helper
Class IfHelper

java.lang.Object
  com.github.jknack.handlebars.helper.IfHelper

All Implemented Interfaces:

Helper<Object>

public class IfHelper
extends Object
implements Helper<Object>

You can use the if helper to conditionally render a block. If its argument returns false, null or empty list/array (a "falsy" value), Handlebars will not render the block.

Since:

0.3.0

Author:

edgar.espina

Field Summary

static Helper<Object>	INSTANCE A singleton instance of this helper.
static String	NAME The helper's name.

Constructor Summary

IfHelper()

Method Summary

CharSequence

apply(Object context, Options options) Callback method for execute the given method.

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

IfHelper

public IfHelper()

Method Detail

apply

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

Description copied from interface: Helper

Callback method for execute the given method.

Specified by:

apply in interface Helper<Object>

Parameters:

context - The context object (param=0).

options - The options object.

Returns:

A string result.

Throws:

IOException - If a template cannot be loaded.