| java.lang.Object
 org.apache.tomcat.util.res.StringManager
| StringManager | | public class StringManager (Code) | | 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: 1.7 $ $Date: 2004/05/11 22:11:01 $
author:
James Duncan Davidson [duncan@eng.sun.com]
author:
James Todd [gonzo@eng.sun.com]
author:
Mel Martinez [mmartinez@g1440.com]
See Also: java.util.ResourceBundle |
| Method Summary | |
| public static synchronized StringManager | getManager(String packageName)
Get the StringManager for a particular package. | | public static synchronized StringManager | getManager(ResourceBundle bundle)
Get the StringManager for a particular package. | | public static synchronized StringManager | getManager(String packageName, Locale loc)
Get the StringManager for a particular package and Locale. | | 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 resource String matching key from underlyingbundle or null if not found.
throws:
IllegalArgumentException - if key is null. | | public String | getString(String key, Object[] args)
Get a string from the underlying resource bundle and format
it with the given set of arguments. | | public String | getString(String key, Object arg)
Get a string from the underlying resource bundle and format it
with the given object argument. | | 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. | | 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. | | 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. |
| getManager | | public static synchronized StringManager getManager(String packageName)(Code) | | 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 - |
| getManager | | public static synchronized StringManager getManager(ResourceBundle bundle)(Code) | | 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 - |
| getManager | | public static synchronized StringManager getManager(String packageName, Locale loc)(Code) | | 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 - |
| getString | | public String getString(String key)(Code) | | Get a string from the underlying resource bundle or return
null if the String is not found.
Parameters:
key - to desired resource String resource String matching key from underlyingbundle or null if not found.
throws:
IllegalArgumentException - if key is null. |
| getString | | public String getString(String key, Object[] args)(Code) | | Get a string from the underlying resource bundle and format
it with the given set of arguments.
Parameters:
key -
Parameters:
args - |
| getString | | public String getString(String key, Object arg)(Code) | | 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 -
Parameters:
arg - |
| getString | | public String getString(String key, Object arg1, Object arg2)(Code) | | 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 -
Parameters:
arg1 -
Parameters:
arg2 - |
| getString | | public String getString(String key, Object arg1, Object arg2, Object arg3)(Code) | | 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 -
Parameters:
arg1 -
Parameters:
arg2 -
Parameters:
arg3 - |
| getString | | public String getString(String key, Object arg1, Object arg2, Object arg3, Object arg4)(Code) | | 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 -
Parameters:
arg1 -
Parameters:
arg2 -
Parameters:
arg3 -
Parameters:
arg4 - |
|
|