org.trimou.handlebars

Class AbstractHelper

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.handlebars.AbstractHelper

All Implemented Interfaces:

ConfigurationAware, Helper

Direct Known Subclasses:

BasicHelper

public abstract class AbstractHelper
extends AbstractConfigurationAware
implements Helper

Author:

Martin Kouba

Constructor Summary

Constructors

Constructor and Description
AbstractHelper()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	append(Options options, java.lang.CharSequence sequence) Escape appended sequence if needed.
protected java.lang.Object	getHashValue(Options options, java.lang.String key)
void	init(Configuration configuration) Initialize the component.
protected boolean	isSection(Options options)
protected boolean	isUnescapeVariable(Options options)
protected boolean	isVariable(Options options)
void	validate(HelperDefinition definition) Helper should validate the tag definition (e.g. number of parameters) during compilation and fail fast if necessary.

Methods inherited from class org.trimou.engine.config.AbstractConfigurationAware

getConfigurationKeys, checkNotInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.trimou.handlebars.Helper

execute

Methods inherited from interface org.trimou.engine.config.ConfigurationAware

getConfigurationKeys

Constructor Detail

AbstractHelper

public AbstractHelper()

Method Detail

validate

public void validate(HelperDefinition definition)

Description copied from interface: Helper

Helper should validate the tag definition (e.g. number of parameters) during compilation and fail fast if necessary. A MustacheException with code MustacheProblem.COMPILE_HELPER_VALIDATION_FAILURE should be thrown in case of validation failure occurs.

Specified by:

validate in interface Helper

init

public void init(Configuration configuration)

Description copied from interface: ConfigurationAware

Initialize the component. Keep in mind that the configuration itself might not be fully initialized yet. However it should be safe to inspect non-configurable components (e.g. properties and global data) and obtain references to other ConfigurationAware components e.g. ( LocaleSupport). This method must not be called directly by the application.

Specified by:

init in interface ConfigurationAware

Overrides:

init in class AbstractConfigurationAware

getHashValue

protected java.lang.Object getHashValue(Options options,
                            java.lang.String key)

isSection

protected boolean isSection(Options options)

isVariable

protected boolean isVariable(Options options)

isUnescapeVariable

protected boolean isUnescapeVariable(Options options)

append

protected void append(Options options,
          java.lang.CharSequence sequence)

Escape appended sequence if needed.

Parameters:

options -

sequence -

See Also:

TextSupport