org.trimou.handlebars

Interface Helper

All Superinterfaces:

ConfigurationAware

All Known Implementing Classes:

AbstractHelper, AbstractTimeFormatHelper, AlternativesHelper, AsyncHelper, BasicSectionHelper, BasicValueHelper, BasicHelper, CacheHelper, DateTimeFormatHelper, EachHelper, EmbedHelper, EqualsHelper, EvalHelper, FormatHelper, ChooseHelper, ChooseHelper.OtherwiseHelper, ChooseHelper.WhenHelper, IfHelper, IncludeHelper, InvokeHelper, IsHelper, JoinHelper, LocaleAwareValueHelper, LogHelper, NullCheckHelper, NumberIsEvenHelper, NumberIsOddHelper, NumberMatchingHelper, NumericExpressionHelper, RepeatHelper, ResourceBundleHelper, SetHelper, SwitchHelper, SwitchHelper.CaseHelper, SwitchHelper.DefaultHelper, TagHelper, TimeFormatHelper, UnlessHelper, WithHelper

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Helper
extends ConfigurationAware

Handlebars-like helper. Must be thread safe.

Class member names in this package sometimes do not make much sense (e.g. Options.fn()), however we've tried to follow the original handlebars terminology as much as possible.

Since:

1.5

Author:

Martin Kouba

See Also:

MustacheEngineBuilder.registerHelper(String, Helper)

Method Summary

Modifier and Type	Method and Description
void	execute(Options options) Execute the helper.
default 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 interface org.trimou.engine.config.ConfigurationAware

getConfigurationKeys, init

Method Detail

execute

void execute(Options options)

Execute the helper.

Parameters:

options -

Throws:

IOException

validate

default void validate(HelperDefinition definition)

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.

Parameters:

definition -