org.apache.tomcat.util.res
Class StringManager

java.lang.Object
  org.apache.tomcat.util.res.StringManager

public class StringManager

extends java.lang.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.

Version:

$Id: StringManager.java 939524 2010-04-30 00:29:29Z kkolinko $

Author:

James Duncan Davidson [duncan@eng.sun.com], James Todd [gonzo@eng.sun.com], Mel Martinez [mmartinez@g1440.com]

See Also:

ResourceBundle

Method Summary

static StringManager	getManager(java.util.ResourceBundle bundle) Get the StringManager for a particular package.
static StringManager	getManager(java.lang.String packageName) Get the StringManager for a particular package.
static StringManager	getManager(java.lang.String packageName, java.util.Locale loc) Get the StringManager for a particular package and Locale.
java.lang.String	getString(java.lang.String key) Get a string from the underlying resource bundle or return null if the String is not found.
java.lang.String	getString(java.lang.String key, java.lang.Object arg) Get a string from the underlying resource bundle and format it with the given object argument.
java.lang.String	getString(java.lang.String key, java.lang.Object[] args) Get a string from the underlying resource bundle and format it with the given set of arguments.
java.lang.String	getString(java.lang.String key, java.lang.Object arg1, java.lang.Object arg2) Get a string from the underlying resource bundle and format it with the given object arguments.
java.lang.String	getString(java.lang.String key, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3) Get a string from the underlying resource bundle and format it with the given object arguments.
java.lang.String	getString(java.lang.String key, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4) Get a string from the underlying resource bundle and format it with the given object arguments.

Methods inherited from class java.lang.Object

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

Method Detail

getString

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

Get a string from the underlying resource bundle or return null if the String is not found.

Parameters:

key - to desired resource String

Returns:

resource String matching key from underlying bundle or null if not found.

Throws:

java.lang.IllegalArgumentException - if key is null.

getString

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

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

Parameters:

key -

args -

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.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 java.lang.String getString(java.lang.String key,
                                  java.lang.Object arg1,
                                  java.lang.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 java.lang.String getString(java.lang.String key,
                                  java.lang.Object arg1,
                                  java.lang.Object arg2,
                                  java.lang.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 java.lang.String getString(java.lang.String key,
                                  java.lang.Object arg1,
                                  java.lang.Object arg2,
                                  java.lang.Object arg3,
                                  java.lang.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 -

getManager

public static StringManager getManager(java.lang.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 - The package name

getManager

public static StringManager getManager(java.util.ResourceBundle bundle)

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:

bundle - The resource bundle

getManager

public static StringManager getManager(java.lang.String packageName,
                                       java.util.Locale loc)

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

Parameters:

packageName - The package name

loc - The locale