com.redhat.rhn.common.localization

Class XmlMessages

java.lang.Object

com.redhat.rhn.common.localization.XmlMessages

public final class XmlMessages
extends java.lang.Object

Utility (Singleton) class to get and format messages centralized by package. Messages are assumed to be in a ResourceBundle called StringResource in a given class' package. ie, If the class is my.package.foo.Bar, the methods will look for the ResourceBundle my.package.foo.StringResource. (The actual file can be a subclass of ResourceBundle or a properties file.) The ResourceBundle keys are assumed to be prefixed with the class name. ie, if the class is my.package.foo.Bar and the key is msg, the methods will then look for the key Bar.msg.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MESSAGE_NOT_FOUND The error warning message in case we don't find a message.
static java.lang.String	PRODUCT_NAME_MACRO

Method Summary

Modifier and Type	Method and Description
java.lang.String	format(java.lang.Class clazz, java.util.Locale locale, java.lang.String key, java.lang.Object... args) Method to format a string from the resource bundle.
java.lang.String	format(java.lang.Class clazz, java.util.Locale locale, java.lang.String key, java.lang.String arg1) Convenience method to format a string from the resource bundle, which takes a single argument.
java.lang.String	format(java.lang.Class clazz, java.util.Locale locale, java.lang.String key, java.lang.String arg1, java.lang.String arg2) Convenience method to format a string from the resource bundle, which takes two arguments.
java.lang.String	format(java.lang.Class clazz, java.util.Locale locale, java.lang.String key, java.lang.String arg1, java.lang.String arg2, java.lang.String arg3) Convenience method to format a string from the resource bundle, which takes three arguments.
protected java.util.ResourceBundle	getBundle(java.lang.String bundleName, java.util.Locale locale) Gets the resource bundle, first checking our internal cache
static XmlMessages	getInstance() Get the instance of the singleton class
java.util.Enumeration	getKeys(java.lang.Class clazz, java.util.Locale locale) Gets the keys of all the strings in the specified class and locale's resource bundle.
java.lang.String	getMessage(java.lang.Class clazz, java.util.Locale locale, java.lang.String key) Obtain a string from the resource file that doesn't require formatting.
void	resetBundleCache() Reload the XML Messages off the disk.

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_NOT_FOUND

public static final java.lang.String MESSAGE_NOT_FOUND

The error warning message in case we don't find a message.

See Also:

Constant Field Values

PRODUCT_NAME_MACRO

public static final java.lang.String PRODUCT_NAME_MACRO

See Also:

Constant Field Values

Method Detail

getInstance

public static XmlMessages getInstance()

Get the instance of the singleton class

Returns:

The instance

resetBundleCache

public void resetBundleCache()

Reload the XML Messages off the disk.

getBundle

protected java.util.ResourceBundle getBundle(java.lang.String bundleName,
                                             java.util.Locale locale)

Gets the resource bundle, first checking our internal cache

Parameters:

bundleName - name of the resource bundle

locale - locale used to retrieve the resource bundle

Returns:

the resource bundle for the given bundleName and locale, always non-null. (An exception is thrown if the bundle can't be found.)

getMessage

public java.lang.String getMessage(java.lang.Class clazz,
                                   java.util.Locale locale,
                                   java.lang.String key)

Obtain a string from the resource file that doesn't require formatting. See the format() methods for obtaining strings that require formatting.

Parameters:

clazz - the class to which the string belongs

locale - the locale used to find the resource bundle

key - the key for the string to be obtained from the resource bundle

Returns:

the message for the given key

format

public java.lang.String format(java.lang.Class clazz,
                               java.util.Locale locale,
                               java.lang.String key,
                               java.lang.String arg1)

Convenience method to format a string from the resource bundle, which takes a single argument.

Parameters:

clazz - the class to which the string belongs

locale - the locale used to find the resource bundle

key - the key for the string to be obtained from the resource bundle

arg1 - the first argument to use in the formatted text

Returns:

the formatted message for the given key and argument

format

public java.lang.String format(java.lang.Class clazz,
                               java.util.Locale locale,
                               java.lang.String key,
                               java.lang.String arg1,
                               java.lang.String arg2)

Convenience method to format a string from the resource bundle, which takes two arguments.

Parameters:

clazz - the class to which the string belongs

locale - the locale used to find the resource bundle

key - the key for the string to be obtained from the resource bundle

arg1 - the first argument to use in the formatted text

arg2 - the second argument to use in the formatted text

Returns:

the formatted message for the given key and arguments

format

public java.lang.String format(java.lang.Class clazz,
                               java.util.Locale locale,
                               java.lang.String key,
                               java.lang.String arg1,
                               java.lang.String arg2,
                               java.lang.String arg3)

Convenience method to format a string from the resource bundle, which takes three arguments.

Parameters:

clazz - the class to which the string belongs

locale - the locale used to find the resource bundle

key - the key for the string to be obtained from the resource bundle

arg1 - the first argument to use in the formatted text

arg2 - the second argument to use in the formatted text

arg3 - the third argument to use in the formatted text

Returns:

the formatted message for the given key and arguments

format

public java.lang.String format(java.lang.Class clazz,
                               java.util.Locale locale,
                               java.lang.String key,
                               java.lang.Object... args)

Method to format a string from the resource bundle. This method allows the user of this class to directly specify the bundle package name to be used. Allows us to have resource bundles in packages without classes. Eliminates the need for "Dummy" classes.

Parameters:

clazz - the class to which the string belongs

locale - the locale used to find the resource bundle

key - the key for the string to be obtained from the resource bundle

args - the arguments that should be applied to the string obtained from the resource bundle. Can be null, to represent no arguments

Returns:

the formatted message for the given key and arguments

getKeys

public java.util.Enumeration getKeys(java.lang.Class clazz,
                                     java.util.Locale locale)

Gets the keys of all the strings in the specified class and locale's resource bundle.

Parameters:

clazz - Class of the resource bundle

locale - locale used to retrieve the resource bundle

Returns:

the Iterator of all the keys