de.ipcon.tools

Class L10nInstanceHelper

java.lang.Object

de.ipcon.tools.L10nInstanceHelper

public class L10nInstanceHelper
extends java.lang.Object

A helper to configure access to L10n bundles and a specific Locale / Fallback Locale once for multiple reuse. Example usage:

  L10nInstanceHelper helper = L10nInstanceHelper.forObject(bo, customer.preferredLocale, Locale.ENGLISH)
  helper.msg('somekey')
 

Constructor Summary

Constructors

Constructor and Description
L10nInstanceHelper(java.lang.String[] paths, java.lang.String preferredLocale, java.util.Locale explicitFallbackLocale, boolean returnKeyIfNotFound) Constructor for L10nInstanceHelper.

Method Summary

Modifier and Type	Method and Description
static L10nInstanceHelper	forObject(java.lang.Object boOrArray, java.lang.String preferredLocaleCode)
static L10nInstanceHelper	forObject(java.lang.Object boOrArray, java.lang.String preferredLocaleCode, java.util.Locale explicitFallbackLocale)
static L10nInstanceHelper	forObject(java.lang.Object boOrArray, java.lang.String preferredLocaleCode, java.util.Locale explicitFallbackLocale, boolean returnKeyIfNotFound)
static L10nInstanceHelper	forPaths(java.lang.String[] paths, java.lang.String preferredLocaleCode)
static L10nInstanceHelper	forPaths(java.lang.String[] paths, java.lang.String preferredLocaleCode, java.util.Locale explicitFallbackLocale)
static L10nInstanceHelper	forPaths(java.lang.String[] paths, java.lang.String preferredLocaleCode, java.util.Locale explicitFallbackLocale, boolean returnKeyIfNotFound)
java.lang.String	msg(java.lang.String key)
java.lang.String	msg(java.lang.String key, java.lang.Object[] args)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

L10nInstanceHelper

public L10nInstanceHelper(java.lang.String[] paths,
                          java.lang.String preferredLocale,
                          java.util.Locale explicitFallbackLocale,
                          boolean returnKeyIfNotFound)

Constructor for L10nInstanceHelper. Either preferredLocale or explicitFallbackLocale has to be provided.

Parameters:

paths - Paths to check for the key, in order. Nonnull.

preferredLocale - the name of the locale which is preferred when resolving the key.

explicitFallbackLocale - an explicit fallback locale. If null, then the global fallback locale of the session is used.

keyIfNotFound - if true and there is no entry for a requested key, then the key is returned. #msg() returns null otherwise.

Method Detail

forObject

public static L10nInstanceHelper forObject(java.lang.Object boOrArray,
                                           java.lang.String preferredLocaleCode)

forObject

public static L10nInstanceHelper forObject(java.lang.Object boOrArray,
                                           java.lang.String preferredLocaleCode,
                                           java.util.Locale explicitFallbackLocale)

forObject

public static L10nInstanceHelper forObject(java.lang.Object boOrArray,
                                           java.lang.String preferredLocaleCode,
                                           java.util.Locale explicitFallbackLocale,
                                           boolean returnKeyIfNotFound)

forPaths

public static L10nInstanceHelper forPaths(java.lang.String[] paths,
                                          java.lang.String preferredLocaleCode)

forPaths

public static L10nInstanceHelper forPaths(java.lang.String[] paths,
                                          java.lang.String preferredLocaleCode,
                                          java.util.Locale explicitFallbackLocale)

forPaths

public static L10nInstanceHelper forPaths(java.lang.String[] paths,
                                          java.lang.String preferredLocaleCode,
                                          java.util.Locale explicitFallbackLocale,
                                          boolean returnKeyIfNotFound)

msg

public java.lang.String msg(java.lang.String key)

msg

public java.lang.String msg(java.lang.String key,
                            java.lang.Object[] args)