com.ibm.portal.model
Interface ResourceBundleProvider

All Superinterfaces:

Localized

public interface ResourceBundleProvider
extends Localized

Allows to load a resource bundle when the set of supported localed for the bundle is known.

Since:

6.1.0

Method Summary

java.util.ResourceBundle	getBundle(java.util.Locale locale) Returns a resource bundle in the given locale.
IterableListModel<java.util.Locale>	getLocales() Returns a list model containing the locales that are supported by this object.
Localized	getLocalized(java.lang.String aKey) Returns a localized object that represents the key into the bundle.
Localized	getLocalized(java.lang.String aTitleKey, java.lang.String aDescriptionKey) Returns a localized object that represents the key into the bundle.
boolean	isEmpty() Checks if there exist any resources in the provider

Methods inherited from interface com.ibm.portal.Localized

getDescription, getTitle

Method Detail

getBundle

java.util.ResourceBundle getBundle(java.util.Locale locale)

Returns a resource bundle in the given locale. If the resource bundle could not be found the method returns null. No fallback will be applied. Fallbacks can be applied by using the Localized.getLocales() method to apply a fallback.

Fetching a ResourceBundle for a Locale is an efficient operation.

Parameters:

locale - requested locale

Returns:

the matching resource bundle or null

getLocales

IterableListModel<java.util.Locale> getLocales()

Description copied from interface: Localized

Returns a list model containing the locales that are supported by this object. The presence of a locale in this list does not mean that a title and description is available, but rather that either one or both are available in that locale.

Specified by:

getLocales in interface Localized

Returns:

a list of locales defined for this object, returns an empty ListModel if no locales are supported.

getLocalized

Localized getLocalized(java.lang.String aKey)

Returns a localized object that represents the key into the bundle. The localized object instances are cached for this provider, so it is an efficient operation of access the localized object for a key.

Parameters:

aKey - the key, not null

Returns:

the localized object, not null

Since:

8.0.0.1

getLocalized

Localized getLocalized(java.lang.String aTitleKey,
                       java.lang.String aDescriptionKey)

Returns a localized object that represents the key into the bundle. The localized object instances are cached for this provider, so it is an efficient operation of access the localized object for a key.

Parameters:

aTitleKey - the key for the title, not null

aDescriptionKey - the key for the description, not null

Returns:

the localized object, not null

Since:

8.0.0.1

isEmpty

boolean isEmpty()

Checks if there exist any resources in the provider

Returns:

true if the provider is empty, else false

Since:

8.5