org.trimou.handlebars

Class FormatHelper

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.handlebars.AbstractHelper

org.trimou.handlebars.BasicHelper

org.trimou.handlebars.BasicValueHelper

org.trimou.handlebars.i18n.LocaleAwareValueHelper

org.trimou.handlebars.FormatHelper

All Implemented Interfaces:

ConfigurationAware, Helper

public class FormatHelper
extends LocaleAwareValueHelper

A simple printf-style format helper.

The first param represents a format string and other params are arguments (referenced by the format specifiers).

 {{fmt 'Hello %s!' 'me'}}
 

A custom Locale can be set via options hash with OptionsHashKeys.LOCALE key.

 {{fmt '%tA' now locale='en'}}
 

Author:

Martin Kouba

See Also:

Formatter

Field Summary

Fields inherited from class org.trimou.handlebars.BasicValueHelper

VALUE_TAG_TYPES

Fields inherited from class org.trimou.handlebars.BasicHelper

HELPER_TAG_TYPES

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

configuration

Constructor Summary

Constructors

Constructor and Description
FormatHelper()

Method Summary

Modifier and Type	Method and Description
void	execute(Options options) Execute the helper.
protected int	numberOfRequiredParameters()

Methods inherited from class org.trimou.handlebars.i18n.LocaleAwareValueHelper

getCurrentLocale, getCurrentLocale, getLocale, getSupportedHashKeys, init

Methods inherited from class org.trimou.handlebars.BasicValueHelper

allowedTagTypes

Methods inherited from class org.trimou.handlebars.BasicHelper

getRequiredHashKeys, numberOfRequiredHashEntries, validate

Methods inherited from class org.trimou.handlebars.AbstractHelper

append, convertAndAppend, convertValue, 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.engine.config.ConfigurationAware

getConfigurationKeys, init

Constructor Detail

FormatHelper

public FormatHelper()

Method Detail

numberOfRequiredParameters

protected int numberOfRequiredParameters()

Overrides:

numberOfRequiredParameters in class BasicHelper

execute

public void execute(Options options)

Description copied from interface: Helper

Execute the helper.