public class StringManager
extends java.lang.Object
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.
ResourceBundle
Modifier and Type | Method and Description |
---|---|
java.util.Locale |
getLocale()
Identify the Locale this StringManager is associated with
|
static StringManager |
getManager(java.lang.Class<?> clazz)
The StringManager will be returned for the package in which the class is
located.
|
static StringManager |
getManager(java.lang.String packageName)
If a manager for a package already exists, it will be reused, else a new
StringManager will be created and returned.
|
static StringManager |
getManager(java.lang.String packageName,
java.util.Enumeration<java.util.Locale> requestedLocales)
Retrieve the StringManager for a list of Locales.
|
static StringManager |
getManager(java.lang.String packageName,
java.util.Locale locale)
If a manager for a package/Locale combination already exists, it will be
reused, else a new StringManager will be created and returned.
|
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... args)
Get a string from the underlying resource bundle and format
it with the given set of arguments.
|
public java.lang.String getString(java.lang.String key)
key
- to desired resource Stringjava.lang.IllegalArgumentException
- if key is nullpublic java.lang.String getString(java.lang.String key, java.lang.Object... args)
key
- The key for the required messageargs
- The values to insert into the messagepublic java.util.Locale getLocale()
public static final StringManager getManager(java.lang.Class<?> clazz)
clazz
- The class for which to retrieve the StringManagerpublic static final StringManager getManager(java.lang.String packageName)
packageName
- The package namepublic static final StringManager getManager(java.lang.String packageName, java.util.Locale locale)
packageName
- The package namelocale
- The Localepublic static StringManager getManager(java.lang.String packageName, java.util.Enumeration<java.util.Locale> requestedLocales)
packageName
- The package for which the StringManager is requiredrequestedLocales
- the list of LocalesCopyright © 2000-2022 Apache Software Foundation. All Rights Reserved.