org.trimou.handlebars.i18n

Class LocaleAwareValueHelper

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

All Implemented Interfaces:

ConfigurationAware, Helper

Direct Known Subclasses:

AbstractTimeFormatHelper, FormatHelper, ResourceBundleHelper

public abstract class LocaleAwareValueHelper
extends BasicValueHelper

An abstract Locale-aware helper. Subclasses are encouraged to use getLocale(Options) to obtain the Locale.

Author:

Martin Kouba

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
LocaleAwareValueHelper()

Method Summary

Modifier and Type	Method and Description
protected Locale	getCurrentLocale()
protected Locale	getCurrentLocale(Options options)
protected Locale	getLocale(Options options)
protected Set<String>	getSupportedHashKeys()
protected void	init() Can be overridden so that there's no need to call super.init(Configuration).

Methods inherited from class org.trimou.handlebars.BasicValueHelper

allowedTagTypes

Methods inherited from class org.trimou.handlebars.BasicHelper

getRequiredHashKeys, numberOfRequiredHashEntries, numberOfRequiredParameters, 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.handlebars.Helper

execute

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

getConfigurationKeys, init

Constructor Detail

LocaleAwareValueHelper

public LocaleAwareValueHelper()

Method Detail

init

protected void init()

Description copied from class: AbstractConfigurationAware

Can be overridden so that there's no need to call super.init(Configuration).

Overrides:

init in class AbstractHelper

getSupportedHashKeys

protected Set<String> getSupportedHashKeys()

Overrides:

getSupportedHashKeys in class BasicHelper

Returns:

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

getCurrentLocale

protected Locale getCurrentLocale()

Returns:

the current locale by means of LocaleSupport

getCurrentLocale

protected Locale getCurrentLocale(Options options)

Parameters:

options -

Returns:

the current locale by means of LocaleSupport

getLocale

protected Locale getLocale(Options options)

Parameters:

options -

Returns:

the locale set via options hash with OptionsHashKeys.LOCALE key, the value from the context for the OptionsHashKeys.LOCALE key or the current locale by means of LocaleSupport

See Also:

Locale.forLanguageTag(String)