com.github.jknack.handlebars.helper

Class MethodHelper

java.lang.Object

com.github.jknack.handlebars.helper.MethodHelper

All Implemented Interfaces:

Helper<java.lang.Object>

public class MethodHelper
extends java.lang.Object
implements Helper<java.lang.Object>

Wrap a method as Handlebars helper.

See Also:

Handlebars.registerHelpers(Object), Handlebars.registerHelpers(Class)

Constructor Summary

Constructors

Constructor and Description
MethodHelper(java.lang.reflect.Method method, java.lang.Object source) Creates a new MethodHelper.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	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

Constructor Detail

MethodHelper

public MethodHelper(java.lang.reflect.Method method,
                    java.lang.Object source)

Creates a new MethodHelper.

Parameters:

method - The method to invoke. Required.

source - The source or instance object. Might be null.

Method Detail

apply

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