Class StoredBundleControl

java.lang.Object

java.util.ResourceBundle.Control

org.tentackle.i18n.StoredBundleControl

All Implemented Interfaces:

DomainContextProvider

public class StoredBundleControl
extends ResourceBundle.Control
implements DomainContextProvider

Bundle control to use stored bundles.
Used by StoredBundleFactory in modular apps as well as by ResourceBundle in non-modular apps.

Author:

harald

Field Summary

Fields inherited from class ResourceBundle.Control

FORMAT_CLASS, FORMAT_DEFAULT, FORMAT_PROPERTIES, TTL_DONT_CACHE, TTL_NO_EXPIRATION_CONTROL

Constructor Summary

Constructors

Constructor	Description
StoredBundleControl()	Creates a stored bundle control object.

Method Summary

Modifier and Type	Method	Description
protected StoredBundle.StoredBundleUDK	createUDK(String baseName, Locale locale)	Creates the unique domain key to load a stored bundle.
DomainContext	getDomainContext()	Gets the domain context.
List<String>	getFormats(String baseName)
long	getTimeToLive(String baseName, Locale locale)
static boolean	isFallbackToProperties()	Returns whether properties should be tried if no stored bundle found.
protected StoredResourceBundle	loadStoredBundle(StoredBundle.StoredBundleUDK key)	Loads the bundle from storage.
ResourceBundle	newBundle(String baseName, Locale locale, String format, ClassLoader loader, boolean reload)
static void	setFallbackToProperties(boolean fallbackToProperties)	Sets whether properties should be tried if no stored bundle found.

Methods inherited from class ResourceBundle.Control

getCandidateLocales, getControl, getFallbackLocale, getNoFallbackControl, needsReload, toBundleName, toResourceName

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface DomainContextProvider

isWithinContext, isWithinContext, on, on, op, op

Constructor Details

StoredBundleControl

public StoredBundleControl()

Creates a stored bundle control object.

Method Details

isFallbackToProperties

public static boolean isFallbackToProperties()

Returns whether properties should be tried if no stored bundle found.

Returns:

true for using resources from properties (default)

setFallbackToProperties

public static void setFallbackToProperties(boolean fallbackToProperties)

Sets whether properties should be tried if no stored bundle found.

Parameters:

fallbackToProperties - true to use resources from properties, false to throw MissingResourceException

getDomainContext

public DomainContext getDomainContext()

Description copied from interface: DomainContextProvider

Gets the domain context.

Specified by:

getDomainContext in interface DomainContextProvider

Returns:

the domain context

getFormats

public List<String> getFormats(String baseName)

Overrides:

getFormats in class ResourceBundle.Control

getTimeToLive

public long getTimeToLive(String baseName,
 Locale locale)

Overrides:

getTimeToLive in class ResourceBundle.Control

newBundle

public ResourceBundle newBundle(String baseName,
 Locale locale,
 String format,
 ClassLoader loader,
 boolean reload)
                         throws IllegalAccessException,
InstantiationException,
IOException

Overrides:

newBundle in class ResourceBundle.Control

Throws:

IllegalAccessException

InstantiationException

IOException

createUDK

protected StoredBundle.StoredBundleUDK createUDK(String baseName,
 Locale locale)

Creates the unique domain key to load a stored bundle.

The locale suffix is derived from the locale, not by searching the bundle name for an underscore: base names may contain underscores themselves, and org.myapp.Texts_v2 must not be read as the bundle org.myapp.Texts for the locale v2.

Parameters:

baseName - the base bundle name of the resource bundle

locale - the locale

Returns:

the unique domain key

loadStoredBundle

protected StoredResourceBundle loadStoredBundle(StoredBundle.StoredBundleUDK key)

Loads the bundle from storage.

Parameters:

key - the unique domain key

Returns:

the stored resource bundle or null if no such bundle in the database