AbstractResourceBundleProvider
public interface ResourceBundleProvider
ResourceBundleProvider
is a service provider interface for resource bundles. It is used by ResourceBundle.getBundle
factory methods to locate and load the service providers that are deployed as modules via ServiceLoader
. baseName
must have a fully-qualified class name of the form: <package of baseName> + ".spi." + <simple name of baseName> + "Provider"
The service type is in a spi
subpackage as it may be packaged in a module separate from the resource bundle providers. For example, the service for a resource bundle named com.example.app.MyResources
must be com.example.app.spi.MyResourcesProvider
: package com.example.app.spi; public interface MyResourcesProvider extends ResourceBundleProvider { }
com.example.app.spi.MyResourcesProvider
" has the following implementation class: This example provides "import com.example.app.spi.MyResourcesProvider; class MyResourcesProviderImpl extends AbstractResourceBundleProvider implements MyResourcesProvider { public MyResourcesProviderImpl() { super("java.properties"); } // this provider maps the resource bundle to per-language package protected String toBundleName(String baseName, Locale locale) { return "p." + locale.getLanguage() + "." + baseName; } public ResourceBundle getBundle(String baseName, Locale locale) { // this module only provides bundles in French if (locale.equals(Locale.FRENCH)) { return super.getBundle(baseName, locale); } // otherwise return null return null; } }
com.example.app.MyResources
" resource bundle of the French locale. Traditionally resource bundles of all locales are packaged in the same package as the resource bundle base name. When deploying resource bundles in more than one modules and two modules containing a package of the same name, split package, is not supported, resource bundles in each module can be packaged in a different package as shown in this example where this provider packages the resource bundles in per-language package, i.e. com.example.app.fr
for French locale. A provider can provide more than one services, each of which is a service for a resource bundle of a different base name.
AbstractResourceBundleProvider
provides the basic implementation for ResourceBundleProvider
and a subclass can override the toBundleName
method to return a provider-specific location of the resource to be loaded, for example, per-language package. A provider can override ResourceBundleProvider.getBundle
method for example to only search the known supported locales or return resource bundles in other formats such as XML.
The module declaration of this provider module specifies the following directive:
provides com.example.app.spi.MyResourcesProvider with com.example.impl.MyResourcesProviderImpl;
ResourceBundle.getBundle
factory methods to obtain a resource bundle from service providers must specify the following directive: uses com.example.app.spi.MyResourcesProvider;
ResourceBundle.getBundle("com.example.app.MyResource", locale)
locates and loads the providers for com.example.app.spi.MyResourcesProvider
service and then invokes ResourceBundleProvider.getBundle("com.example.app.MyResource", locale)
to find the resource bundle of the given base name and locale. If the consumer module is a resource bundle service provider for com.example.app.spi.MyResourcesProvider
, ResourceBundle.getBundle
will locate resource bundles only from service providers. Otherwise, ResourceBundle.getBundle
may continue the search of the resource bundle in other modules and class path per the specification of the ResourceBundle.getBundle
method being called.Modifier and Type | Method | Description |
---|---|---|
ResourceBundle |
getBundle |
Returns a ResourceBundle for the given bundle name and locale. |
ResourceBundle getBundle(String baseName, Locale locale)
ResourceBundle
for the given bundle name and locale. This method returns null
if there is no ResourceBundle
found for the given parameters.baseName
- the base bundle name of the resource bundle, a fully qualified class namelocale
- the locale for which the resource bundle should be loadedResourceBundle
for the given parameters is found
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/spi/ResourceBundleProvider.html