Package org.apache.sling.i18n
Interface ResourceBundleProvider
-
public interface ResourceBundleProvider
TheResourceBundleProvider
service interface defines the API for a service, which is capable of returnedResourceBundle
for given anyLocale
.This interface defines the service API implemented by the existing implementation. It is not intended to be implemented by application bundles. Rather such bundles should get the
ResourceBundleProvider
service from the service registry to access the data provided.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
BUNDLE_REQ_ATTR
Request attribute to get the resource bundle.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.Locale
getDefaultLocale()
Returns the defaultLocale
assumed by this instance.java.util.ResourceBundle
getResourceBundle(java.lang.String baseName, java.util.Locale locale)
Returns aResourceBundle
for the given locale.java.util.ResourceBundle
getResourceBundle(java.util.Locale locale)
Returns aResourceBundle
for the given locale.
-
-
-
Field Detail
-
BUNDLE_REQ_ATTR
static final java.lang.String BUNDLE_REQ_ATTR
Request attribute to get the resource bundle.- Since:
- 2.2
- See Also:
- Constant Field Values
-
-
Method Detail
-
getDefaultLocale
java.util.Locale getDefaultLocale()
Returns the defaultLocale
assumed by this instance.- Returns:
- The default locale or
null
.
-
getResourceBundle
java.util.ResourceBundle getResourceBundle(java.util.Locale locale)
Returns aResourceBundle
for the given locale.- Parameters:
locale
- TheLocale
for which to return the resource bundle. If this isnull
the default locale as returned bygetDefaultLocale()
is assumed.- Returns:
- The
ResourceBundle
for the given locale - Throws:
java.util.MissingResourceException
- If the service is not capable of returning aResourceBundle
-
getResourceBundle
java.util.ResourceBundle getResourceBundle(java.lang.String baseName, java.util.Locale locale)
Returns aResourceBundle
for the given locale.- Parameters:
baseName
- The base name for the resource bundle. If this isnull
, the same resource bundle will be returned as when calling thegetResourceBundle(Locale)
method.locale
- TheLocale
for which to return the resource bundle. If this isnull
the default locale as returned bygetDefaultLocale()
is assumed.- Returns:
- The
ResourceBundle
for the given locale - Throws:
java.util.MissingResourceException
- If the service is not capable of returning aResourceBundle
-
-