org.trimou.handlebars.i18n

Class AbstractTimeFormatHelper<F,S>

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.i18n.AbstractTimeFormatHelper<F,S>

Type Parameters:

F - The formattable object type

S - The style type

All Implemented Interfaces:

ConfigurationAware, Helper

Direct Known Subclasses:

DateTimeFormatHelper, TimeFormatHelper

public abstract class AbstractTimeFormatHelper<F,S>
extends LocaleAwareValueHelper

An abstract time formatting helper.

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

Method Summary

Modifier and Type	Method and Description
protected abstract String	defaultFormat(F value, Locale locale, TimeZone timeZone)
void	execute(Options options) Execute the helper.
protected abstract String	format(F value, S style, Locale locale, TimeZone timeZone)
protected abstract String	format(F value, String pattern, Locale locale, TimeZone timeZone)
protected abstract F	getFormattableObject(Object value, Locale locale, TimeZone timeZone, MustacheTagInfo tagInfo)
protected Set<String>	getSupportedHashKeys()
protected TimeZone	getTimeZone(Options options)
protected abstract S	parseStyle(String style, MustacheTagInfo tagInfo)
protected MustacheException	unknownStyle(String style, MustacheTagInfo tagInfo)
protected MustacheException	valueNotAFormattableObject(Object value, MustacheTagInfo tagInfo)

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

getCurrentLocale, getCurrentLocale, getLocale, init

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.engine.config.ConfigurationAware

getConfigurationKeys, init

Constructor Detail

AbstractTimeFormatHelper

public AbstractTimeFormatHelper()

Method Detail

execute

public void execute(Options options)

Description copied from interface: Helper

Execute the helper.

getSupportedHashKeys

protected Set<String> getSupportedHashKeys()

Overrides:

getSupportedHashKeys in class LocaleAwareValueHelper

Returns:

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

defaultFormat

protected abstract String defaultFormat(F value,
                                        Locale locale,
                                        TimeZone timeZone)

Parameters:

value -

Returns:

the default formatted string

format

protected abstract String format(F value,
                                 S style,
                                 Locale locale,
                                 TimeZone timeZone)

Parameters:

value -

style -

Returns:

the formatted string for the given style

format

protected abstract String format(F value,
                                 String pattern,
                                 Locale locale,
                                 TimeZone timeZone)

Parameters:

value -

pattern -

Returns:

the formatted string for the given pattern

parseStyle

protected abstract S parseStyle(String style,
                                MustacheTagInfo tagInfo)

Parameters:

style -

tagInfo -

Returns:

the style

getFormattableObject

protected abstract F getFormattableObject(Object value,
                                          Locale locale,
                                          TimeZone timeZone,
                                          MustacheTagInfo tagInfo)

Parameters:

value -

tagInfo -

Returns:

the formattable object

Throws:

MustacheException - If the given value does not represent a formattable object

getTimeZone

protected TimeZone getTimeZone(Options options)

Parameters:

options -

Returns:

the timezone specified in the options hash, or the default one

valueNotAFormattableObject

protected MustacheException valueNotAFormattableObject(Object value,
                                                       MustacheTagInfo tagInfo)

unknownStyle

protected MustacheException unknownStyle(String style,
                                         MustacheTagInfo tagInfo)