java.util
public abstract class ResourceBundle extends Object
getBundle
. Now you can get your object by calling
getObject
or getString
on that bundle.
When a bundle is demanded for a specific locale, the ResourceBundle
is searched in following order (def. language stands for the
two letter ISO language code of the default locale (see
Locale.getDefault()
).
baseName_language code_country code_variant baseName_language code_country code baseName_language code baseName_def. language_def. country_def. variant baseName_def. language_def. country baseName_def. language baseName
A bundle is backed up by less specific bundles (omitting variant, country or language). But it is not backed up by the default language locale.
If you provide a bundle for a given locale, say
Bundle_en_UK_POSIX
, you must also provide a bundle for
all sub locales, ie. Bundle_en_UK
, Bundle_en
, and
Bundle
.
When a bundle is searched, we look first for a class with the given
name, then for a file with .properties
extension in the
classpath. The name must be a fully qualified classname (with dots as
path separators).
(Note: This implementation always backs up the class with a properties file if that is existing, but you shouldn't rely on this, if you want to be compatible to the standard JDK.)
Locale
,
ListResourceBundle
,
PropertyResourceBundle
Modifier and Type | Field and Description |
---|---|
protected ResourceBundle |
parent
The parent bundle.
|
Constructor and Description |
---|
ResourceBundle()
The constructor.
|
Modifier and Type | Method and Description |
---|---|
static void |
clearCache()
Remove all resources from the cache that were loaded
using the class loader of the calling class.
|
static void |
clearCache(ClassLoader loader)
Remove all resources from the cache that were loaded
using the specified class loader.
|
static ResourceBundle |
getBundle(String baseName)
Get the appropriate ResourceBundle for the default locale.
|
static ResourceBundle |
getBundle(String baseName,
Locale locale)
Get the appropriate ResourceBundle for the given locale.
|
static ResourceBundle |
getBundle(String baseName,
Locale locale,
ClassLoader classLoader)
Get the appropriate ResourceBundle for the given locale.
|
abstract Enumeration<String> |
getKeys()
This method should return all keys for which a resource exists; you
should include the enumeration of any parent's keys, after filtering out
duplicates.
|
Locale |
getLocale()
Return the actual locale of this bundle.
|
Object |
getObject(String key)
Get an object from this resource bundle.
|
String |
getString(String key)
Get a String from this resource bundle.
|
String[] |
getStringArray(String key)
Get an array of Strings from this resource bundle.
|
protected abstract Object |
handleGetObject(String key)
Override this method to provide the resource for a keys.
|
protected void |
setParent(ResourceBundle parent)
Set the parent of this bundle.
|
protected ResourceBundle parent
public ResourceBundle()
public final String getString(String key)
key
- the name of the resourceMissingResourceException
- if the resource can't be foundNullPointerException
- if key is nullClassCastException
- if resource is not a stringpublic final String[] getStringArray(String key)
key
- the name of the resourceMissingResourceException
- if the resource can't be foundNullPointerException
- if key is nullClassCastException
- if resource is not a stringpublic final Object getObject(String key)
handleGetObject
for this resource and all of its parents,
until it finds a non-null resource.key
- the name of the resourceMissingResourceException
- if the resource can't be foundNullPointerException
- if key is nullpublic Locale getLocale()
protected void setParent(ResourceBundle parent)
parent
- the parent of this bundlepublic static ResourceBundle getBundle(String baseName)
getBundle(baseName, Locale.getDefault(),
getClass().getClassLoader()
, except that any security check of
getClassLoader won't fail.baseName
- the name of the ResourceBundleMissingResourceException
- if the resource bundle can't be foundNullPointerException
- if baseName is nullpublic static ResourceBundle getBundle(String baseName, Locale locale)
getBundle(baseName, locale,
getClass().getClassLoader()
, except that any security check of
getClassLoader won't fail.baseName
- the name of the ResourceBundlelocale
- A localeMissingResourceException
- if the resource bundle can't be foundNullPointerException
- if baseName or locale is nullpublic static ResourceBundle getBundle(String baseName, Locale locale, ClassLoader classLoader)
A sequence of candidate bundle names are generated, and tested in this order, where the suffix 1 means the string from the specified locale, and the suffix 2 means the string from the default locale:
In the sequence, entries with an empty string are ignored. Next,
getBundle
tries to instantiate the resource bundle:
Next, the parent chain is implemented. The remaining candidate names
in the above sequence are tested in a similar manner, and if any results
in a resource bundle, it is assigned as the parent of the first bundle
using the setParent
method (unless the first bundle already
has a parent).
For example, suppose the following class and property files are provided: MyResources.class, MyResources_fr_CH.properties, MyResources_fr_CH.class, MyResources_fr.properties, MyResources_en.properties, and MyResources_es_ES.class. The contents of all files are valid (that is, public non-abstract subclasses of ResourceBundle with public nullary constructors for the ".class" files, syntactically correct ".properties" files). The default locale is Locale("en", "UK").
Calling getBundle with the shown locale argument values instantiates resource bundles from the following sources:
The file MyResources_fr_CH.properties is never used because it is hidden by MyResources_fr_CH.class.
baseName
- the name of the ResourceBundlelocale
- A localeclassLoader
- a ClassLoaderMissingResourceException
- if the resource bundle can't be foundNullPointerException
- if any argument is nullprotected abstract Object handleGetObject(String key)
getObject
. If you don't have a resource
for the given key, you should return null instead throwing a
MissingResourceException. You don't have to ask the parent, getObject()
already does this; nor should you throw a MissingResourceException.key
- the key of the resourceNullPointerException
- if key is nullpublic abstract Enumeration<String> getKeys()
public static final void clearCache()
public static final void clearCache(ClassLoader loader)
loader
- the loader used for the bundles that will be removed.NullPointerException
- if loader
is null
.