org.trimou.handlebars.i18n

Class ResourceBundleHelper

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.ResourceBundleHelper

All Implemented Interfaces:

ConfigurationAware, Helper

public class ResourceBundleHelper
extends LocaleAwareValueHelper

First register the helper instance:

MustacheEngineBuilder.newBuilder().registerHelper("msg", new ResourceBundleHelper("messages")).build();

Than use the helper in the template:

{{msg "my.key"}}

The key need not be a string literal:

{{msg foo.key}}

You may also override the default baseName:

{{msg "my.key" baseName="messages"}}

And also use message parameters and Formatter or MessageFormat:

hello.key=Hello %s!

{{msg "hello.key" "world" format="printf"}}

See also ResourceBundleHelper.Format for more info about formats.

Author:

Martin Kouba

See Also:

LocaleSupport

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceBundleHelper.Format

Field Summary

Fields inherited from class org.trimou.handlebars.BasicValueHelper

VALUE_TAG_TYPES

Fields inherited from class org.trimou.handlebars.BasicHelper

HELPER_TAG_TYPES

Constructor Summary

Constructors

Constructor and Description
ResourceBundleHelper(java.lang.String defaultBaseName)
ResourceBundleHelper(java.lang.String defaultBaseName, ResourceBundleHelper.Format defaultFormat)

Method Summary

Methods

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

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

getCurrentLocale, init

Methods inherited from class org.trimou.handlebars.BasicValueHelper

allowedTagTypes

Methods inherited from class org.trimou.handlebars.BasicHelper

numberOfRequiredHashEntries, numberOfRequiredParameters, validate

Methods inherited from class org.trimou.handlebars.AbstractHelper

append, getHashValue, isSection, isUnescapeVariable, isVariable

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

getConfigurationKeys, checkNotInitialized

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

Constructor Detail

ResourceBundleHelper

public ResourceBundleHelper(java.lang.String defaultBaseName)

Parameters:

defaultBaseName -

ResourceBundleHelper

public ResourceBundleHelper(java.lang.String defaultBaseName,
                    ResourceBundleHelper.Format defaultFormat)

Parameters:

defaultBaseName -

defaultFormat -

Method Detail

execute

public void execute(Options options)

Description copied from interface: Helper

Execute the helper.