org.onehippo.forge.hst.spring.support

Interface RepositoryResourceBundleMessageFormatProvider

All Known Implementing Classes:

CachingRepositoryResourceBundleMessageFormatProvider

public interface RepositoryResourceBundleMessageFormatProvider

Repository based ResourceBundle MessageFormat Provider.

This interface is responsible for creating and caching the resolved MessageFormat instances and refreshing outdated MessageFormat instances.

Method Summary

Modifier and Type	Method and Description
MessageFormat	getMessageFormat(ResourceBundle bundle, String code, Locale locale) Return a MessageFormat for the given bundle and code, fetching already generated MessageFormats from the cache.
void	registerBundle(String basename, Locale locale, ResourceBundle bundle) Register the live bundle by the basename and locale in order to be able to determine that the bundle was originated from repository.
void	registerPreviewBundle(String basename, Locale locale, ResourceBundle bundle) Register the preview bundle by the basename and locale in order to be able to determine that the bundle was originated from repository.

Method Detail

registerBundle

void registerBundle(String basename,
                    Locale locale,
                    ResourceBundle bundle)

Register the live bundle by the basename and locale in order to be able to determine that the bundle was originated from repository.

Note: Whenever retrieve a resource bundle from repository, this method should be invoked. Then this implementation should register it if not yet done or clear any outdated cache associated with the basename and locale for a refreshed bundle.

Parameters:

basename - resource bundle basename

locale - resource bundle locale

bundle - resource bundle

registerPreviewBundle

void registerPreviewBundle(String basename,
                           Locale locale,
                           ResourceBundle bundle)

Register the preview bundle by the basename and locale in order to be able to determine that the bundle was originated from repository.

Note: Whenever retrieve a resource bundle from repository, this method should be invoked. Then this implementation should register it if not yet done or clear any outdated cache associated with the basename and locale for a refreshed bundle.

Parameters:

basename - resource bundle basename

locale - resource bundle locale

bundle - resource bundle

getMessageFormat

MessageFormat getMessageFormat(ResourceBundle bundle,
                               String code,
                               Locale locale)

Return a MessageFormat for the given bundle and code, fetching already generated MessageFormats from the cache.

Parameters:

bundle - the ResourceBundle to work on

code - the message code to retrieve

locale - the Locale to use to build the MessageFormat

Returns:

the resulting MessageFormat, or null if no message defined for the given code