org.trimou.handlebars

Class BasicHelper

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.handlebars.AbstractHelper

org.trimou.handlebars.BasicHelper

All Implemented Interfaces:

ConfigurationAware, Helper

Direct Known Subclasses:

AlternativesHelper, BasicSectionHelper, BasicValueHelper, EvalHelper, InvokeHelper, NumberMatchingHelper, NumericExpressionHelper, TagHelper

public abstract class BasicHelper
extends AbstractHelper

Basic validating helper.

Author:

Martin Kouba

Field Summary

Fields

Modifier and Type	Field and Description
protected static MustacheTagType[]	HELPER_TAG_TYPES

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

configuration

Constructor Summary

Constructors

Constructor and Description
BasicHelper()

Method Summary

Modifier and Type	Method and Description
protected MustacheTagType[]	allowedTagTypes()
protected Set<String>	getRequiredHashKeys()
protected Set<String>	getSupportedHashKeys()
protected int	numberOfRequiredHashEntries()
protected int	numberOfRequiredParameters()
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.handlebars.AbstractHelper

append, convertAndAppend, convertValue, init, isSection, isUnescapeVariable, isVariable

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

checkNotInitialized, init

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, init

Field Detail

HELPER_TAG_TYPES

protected static final MustacheTagType[] HELPER_TAG_TYPES

Constructor Detail

BasicHelper

public BasicHelper()

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.

allowedTagTypes

protected MustacheTagType[] allowedTagTypes()

numberOfRequiredParameters

protected int numberOfRequiredParameters()

numberOfRequiredHashEntries

protected int numberOfRequiredHashEntries()

getRequiredHashKeys

protected Set<String> getRequiredHashKeys()

getSupportedHashKeys

protected Set<String> getSupportedHashKeys()

Returns:

a set of supported hash keys or singleton of value * to allow any hash keys