org.apache.tomcat.util.res

Class 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.

Version: $Revision: 769384 $ $Date: 2009-04-28 15:14:14 +0200 (Tue, 28 Apr 2009) $

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

See Also: java.util.ResourceBundle

Method Summary
static StringManagergetManager(String packageName)
Get the StringManager for a particular package.
static StringManagergetManager(ResourceBundle bundle)
Get the StringManager for a particular package.
static StringManagergetManager(String packageName, Locale loc)
Get the StringManager for a particular package and Locale.
StringgetString(String key)
Get a string from the underlying resource bundle or return null if the String is not found.
StringgetString(String key, Object... args)
Get a string from the underlying resource bundle and format it with the given set of arguments.

Method Detail

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 The package name

getManager

public static StringManager getManager(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(String packageName, 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

getString

public String getString(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: IllegalArgumentException if key is null.

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

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.