org.apache.shindig.gadgets

Interface MessageBundleFactory

All Known Implementing Classes:

DefaultMessageBundleFactory

public interface MessageBundleFactory

Factory of message bundles

Method Summary

Methods

Modifier and Type	Method and Description
MessageBundle	getBundle(GadgetSpec spec, Locale locale, boolean ignoreCache, String container, String view) Retrieves a messagMessageBundle for the provided GadgetSpec and Locale.

Method Detail

getBundle

MessageBundle getBundle(GadgetSpec spec,
                      Locale locale,
                      boolean ignoreCache,
                      String container,
                      String view)
                        throws GadgetException

Retrieves a messagMessageBundle for the provided GadgetSpec and Locale. Implementations must be sure to perform proper merging of message bundles of lower specifity with exact matches (exact > lang only > country only > all / all)

Parameters:

spec - The gadget to inspect for Locales.

locale - The language and country to get a message bundle for.

ignoreCache - True to bypass any caching of message bundles for debugging purposes.

container - The container that is requesting this message bundle

view - The view for which to return the Locale appropriate message bundle. To retrieve only globally scoped bundles pass 'null'.

Returns:

The newly created MesageBundle.

Throws:

GadgetException - if retrieval fails for any reason.