org.apache.catalina.util

Class StringManager

java.lang.Object

org.apache.catalina.util.StringManager

public class StringManager
extends Object

An internationalization / localization helper class which reduces the bother of handling ResourceBundles and takes care of the common cases of message formating which otherwise require the creation of Object arrays and such.

The StringManager operates on a package basis. One StringManager per package can be created and accessed via the getManager method call.

The StringManager will look for a ResourceBundle named by the package name given plus the suffix of "LocalStrings". In practice, this means that the localized information will be contained in a LocalStrings.properties file located in the package directory of the classpath.

Please see the documentation for java.util.ResourceBundle for more information.

Author:

James Duncan Davidson [[email protected]], James Todd [[email protected]]

Method Summary

Modifier and Type	Method and Description
static StringManager	getManager(String packageName) Get the StringManager for a particular package.
Locale	getResourceBundleLocale(Locale requestLocale) Returns the locale of the resource bundle for the given request locale.
String	getString(String key) Get a string from the underlying resource bundle.
String	getString(String key, Locale locale)
String	getString(String key, Object arg) Get a string from the underlying resource bundle and format it with the given object argument.
String	getString(String key, Object[] args) Get a string from the underlying resource bundle and format it with the given set of arguments.
String	getString(String key, Object[] args, Locale locale)
String	getString(String key, Object arg, Locale locale)
String	getString(String key, Object arg1, Object arg2) Get a string from the underlying resource bundle and format it with the given object arguments.
String	getString(String key, Object arg1, Object arg2, Locale locale)
String	getString(String key, Object arg1, Object arg2, Object arg3) Get a string from the underlying resource bundle and format it with the given object arguments.
String	getString(String key, Object arg1, Object arg2, Object arg3, Locale locale)
String	getString(String key, Object arg1, Object arg2, Object arg3, Object arg4) Get a string from the underlying resource bundle and format it with the given object arguments.
String	getString(String key, Object arg1, Object arg2, Object arg3, Object arg4, Locale locale)
protected String	getStringInternal(String key)
protected String	getStringInternal(String key, Locale locale)

Methods inherited from class java.lang.Object

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

Method Detail

getString

public String getString(String key)

Get a string from the underlying resource bundle.

Parameters:

key -

getString

public String getString(String key,
                        Locale locale)

getStringInternal

protected String getStringInternal(String key)

getStringInternal

protected String getStringInternal(String key,
                                   Locale locale)

getString

public String getString(String key,
                        Object[] args)

Get a string from the underlying resource bundle and format it with the given set of arguments.

Parameters:

key -

args -

getString

public String getString(String key,
                        Object[] args,
                        Locale locale)

getString

public String getString(String key,
                        Object arg)

Get a string from the underlying resource bundle and format it with the given object argument. This argument can of course be a String object.

Parameters:

key -

arg -

getString

public String getString(String key,
                        Object arg,
                        Locale locale)

getString

public String getString(String key,
                        Object arg1,
                        Object arg2)

Get a string from the underlying resource bundle and format it with the given object arguments. These arguments can of course be String objects.

Parameters:

key -

arg1 -

arg2 -

getString

public String getString(String key,
                        Object arg1,
                        Object arg2,
                        Locale locale)

getString

public String getString(String key,
                        Object arg1,
                        Object arg2,
                        Object arg3)

Get a string from the underlying resource bundle and format it with the given object arguments. These arguments can of course be String objects.

Parameters:

key -

arg1 -

arg2 -

arg3 -

getString

public String getString(String key,
                        Object arg1,
                        Object arg2,
                        Object arg3,
                        Locale locale)

getString

public String getString(String key,
                        Object arg1,
                        Object arg2,
                        Object arg3,
                        Object arg4)

Get a string from the underlying resource bundle and format it with the given object arguments. These arguments can of course be String objects.

Parameters:

key -

arg1 -

arg2 -

arg3 -

arg4 -

getString

public String getString(String key,
                        Object arg1,
                        Object arg2,
                        Object arg3,
                        Object arg4,
                        Locale locale)

getResourceBundleLocale

public Locale getResourceBundleLocale(Locale requestLocale)

Returns the locale of the resource bundle for the given request locale.

getManager

public static StringManager getManager(String packageName)

Get the StringManager for a particular package. If a manager for a package already exists, it will be reused, else a new StringManager will be created and returned.

Parameters:

packageName -