org.jboss.dna.common.i18n
Class I18n

java.lang.Object
  org.jboss.dna.common.i18n.I18n

@ThreadSafe
public final class I18n
extends java.lang.Object

Manages the initialization of internationalization (i18n) files, substitution of values within i18n message placeholders, and dynamically reading properties from i18n property files.

Author:

John Verhaeg, Randall Hauch

Method Summary

static java.util.Set<java.util.Locale>	getLocalizationProblemLocales(java.lang.Class i18nClass) Note, calling this method will not trigger localization of the supplied internationalization class.
static java.util.Set<java.lang.String>	getLocalizationProblems(java.lang.Class i18nClass) Note, calling this method will not trigger localization of the supplied internationalization class.
static java.util.Set<java.lang.String>	getLocalizationProblems(java.lang.Class i18nClass, java.util.Locale locale) Note, calling this method will not trigger localization of the supplied internationalization class.
static LocalizationRepository	getLocalizationRepository() Get the repository of localized messages.
boolean	hasProblem()
boolean	hasProblem(java.util.Locale locale)
java.lang.String	id()
static void	initialize(java.lang.Class i18nClass) Initializes the internationalization fields declared on the supplied class.
java.lang.String	problem()
java.lang.String	problem(java.util.Locale locale)
static void	setLocalizationRepository(LocalizationRepository localizationRepository) Set the repository of localized messages.
java.lang.String	text(java.util.Locale locale, java.lang.Object... arguments) Get the localized text for the supplied locale, replacing the parameters in the text with those supplied.
java.lang.String	text(java.lang.Object... arguments) Get the localized text for the current (default) locale, replacing the parameters in the text with those supplied.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getLocalizationProblemLocales

public static java.util.Set<java.util.Locale> getLocalizationProblemLocales(java.lang.Class i18nClass)

Note, calling this method will not trigger localization of the supplied internationalization class.

Parameters:

i18nClass - The internalization class for which localization problem locales should be returned.

Returns:

The locales for which localization problems were encountered while localizing the supplied internationalization class; never null.

getLocalizationProblems

public static java.util.Set<java.lang.String> getLocalizationProblems(java.lang.Class i18nClass)

Note, calling this method will not trigger localization of the supplied internationalization class.

Parameters:

i18nClass - The internalization class for which localization problems should be returned.

Returns:

The localization problems encountered while localizing the supplied internationalization class to the default locale; never null.

getLocalizationProblems

public static java.util.Set<java.lang.String> getLocalizationProblems(java.lang.Class i18nClass,
                                                                      java.util.Locale locale)

Note, calling this method will not trigger localization of the supplied internationalization class.

Parameters:

i18nClass - The internalization class for which localization problems should be returned.

locale - The locale for which localization problems should be returned. If null, the default locale will be used.

Returns:

The localization problems encountered while localizing the supplied internationalization class to the supplied locale; never null.

getLocalizationRepository

public static LocalizationRepository getLocalizationRepository()

Get the repository of localized messages. By default, this instance uses a ClasspathLocalizationRepository that uses this class' classloader.

Returns:

localizationRepository

setLocalizationRepository

public static void setLocalizationRepository(LocalizationRepository localizationRepository)

Set the repository of localized messages. If null, a ClasspathLocalizationRepository instance that uses this class loader will be used.

Parameters:

localizationRepository - the localization repository to use; may be null if the default repository should be used.

initialize

public static void initialize(java.lang.Class i18nClass)

Initializes the internationalization fields declared on the supplied class. Internationalization fields must be public, static, not final, and of type I18n. The supplied class must not be an interface (of course), but has no restrictions as to what class it may extend or what interfaces it must implement.

Parameters:

i18nClass - A class declaring one or more public, static, non-final fields of type I18n.

id

public java.lang.String id()

Returns:

This internationalization object's ID, which will match both the name of the relevant static field in the internationalization class and the relevant property name in the associated localization files.

hasProblem

public boolean hasProblem()

Returns:

true if a problem was encountered while localizing this internationalization object to the default locale.

hasProblem

public boolean hasProblem(java.util.Locale locale)

Parameters:

locale - The locale for which to check whether a problem was encountered.

Returns:

true if a problem was encountered while localizing this internationalization object to the supplied locale.

problem

public java.lang.String problem()

Returns:

The problem encountered while localizing this internationalization object to the default locale, or null if none was encountered.

problem

public java.lang.String problem(java.util.Locale locale)

Parameters:

locale - The locale for which to return the problem.

Returns:

The problem encountered while localizing this internationalization object to the supplied locale, or null if none was encountered.

text

public java.lang.String text(java.lang.Object... arguments)

Get the localized text for the current (default) locale, replacing the parameters in the text with those supplied.

Parameters:

arguments - the arguments for the parameter replacement; may be null or empty

Returns:

the localized text

text

public java.lang.String text(java.util.Locale locale,
                             java.lang.Object... arguments)

Get the localized text for the supplied locale, replacing the parameters in the text with those supplied.

Parameters:

locale - the locale, or null if the current (default) locale should be used

arguments - the arguments for the parameter replacement; may be null or empty

Returns:

the localized text

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object