com.github.jknack.handlebars.helper

Class LookupHelper

java.lang.Object

com.github.jknack.handlebars.helper.LookupHelper

All Implemented Interfaces:

Helper<Object>

public class LookupHelper
extends Object
implements Helper<Object>

Lookup helper, which allows to get a context variable... It is kind of useless, but it it present to keep better integration with handlebars.js. It was introduced with dynamic partials:

 {{> (lookup '.' 'myVariable') }}
 

This helper is useless bc it shouldn't be required to get a variable via a helper, like:

 {{> (myVariable) }}
 

For now, previous expression isn't supported in Handlebars.java... but the only reason of that is handlebars.js

Since:

2.2.0

Author:

edgar

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
LookupHelper()

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

LookupHelper

public LookupHelper()

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.