org.apache.catalina.util
Class StringManager
java.lang.Object
org.apache.catalina.util.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.
- James Duncan Davidson [duncan@eng.sun.com]
- James Todd [gonzo@eng.sun.com]
static StringManager | getManager(String packageName) - Get the StringManager for a particular package.
|
String | getString(String key) - Get a string from the underlying resource bundle.
|
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 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, 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, Object arg4) - Get a string from the underlying resource bundle and format it
with the given object arguments.
|
String | getString(String key, Object[] args) - Get a string from the underlying resource bundle and format
it with the given set of arguments.
|
protected String | getStringInternal(String key)
|
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.
packageName
- The package name
getString
public String getString(String key)
Get a string from the underlying resource bundle.
key
- The resource name
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.
key
- The resource namearg
- Formatting directive
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.
key
- The resource namearg1
- Formatting directivearg2
- Formatting directive
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.
key
- The resource namearg1
- Formatting directivearg2
- Formatting directivearg3
- Formatting directive
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.
key
- The resource namearg1
- Formatting directivearg2
- Formatting directivearg3
- Formatting directivearg4
- Formatting directive
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.
key
- The resource nameargs
- Formatting directives
getStringInternal
protected String getStringInternal(String key)
Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.