java.util

Class ResourceBundle.Control

java.lang.Object

java.util.ResourceBundle.Control

Enclosing class:

ResourceBundle

public static class ResourceBundle.Control
extends Object

ResourceBundle.Control is a static utility class defines ResourceBundle load access methods, its default access order is as the same as before. However users can implement their own control.

Since:

1.6

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	FORMAT_CLASS a list defines java class format
static List<String>	FORMAT_DEFAULT a list defines default format
static List<String>	FORMAT_PROPERTIES a list defines property format
static long	TTL_DONT_CACHE a constant that indicates cache will not be used.
static long	TTL_NO_EXPIRATION_CONTROL a constant that indicates cache will not be expired.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Control() default constructor

Method Summary

Modifier and Type	Method and Description
List<Locale>	getCandidateLocales(String baseName, Locale locale) Returns a list of candidate locales according to baseName in locale.
static ResourceBundle.Control	getControl(List<String> formats) Returns a control according to formats.
Locale	getFallbackLocale(String baseName, Locale locale) Returns the fallback locale for baseName in locale.
List<String>	getFormats(String baseName) Returns a list of strings of formats according to baseName.
static ResourceBundle.Control	getNoFallbackControl(List<String> formats) Returns a control according to formats whose fallback locale is null.
long	getTimeToLive(String baseName, Locale locale) Returns the time to live of the ResourceBundle baseName in locale, default is TTL_NO_EXPIRATION_CONTROL.
boolean	needsReload(String baseName, Locale locale, String format, ClassLoader loader, ResourceBundle bundle, long loadTime) Returns true if the ResourceBundle needs to reload.
ResourceBundle	newBundle(String baseName, Locale locale, String format, ClassLoader loader, boolean reload) Returns a new ResourceBundle.
String	toBundleName(String baseName, Locale locale) a utility method to answer the name of a resource bundle according to the given base name and locale
String	toResourceName(String bundleName, String suffix) a utility method to answer the name of a resource according to the given bundleName and suffix

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT_DEFAULT

public static final List<String> FORMAT_DEFAULT

a list defines default format

FORMAT_CLASS

public static final List<String> FORMAT_CLASS

a list defines java class format

FORMAT_PROPERTIES

public static final List<String> FORMAT_PROPERTIES

a list defines property format

TTL_DONT_CACHE

public static final long TTL_DONT_CACHE

a constant that indicates cache will not be used.

See Also:

Constant Field Values

TTL_NO_EXPIRATION_CONTROL

public static final long TTL_NO_EXPIRATION_CONTROL

a constant that indicates cache will not be expired.

See Also:

Constant Field Values

Constructor Detail

Control

protected Control()

default constructor

Method Detail

getControl

public static ResourceBundle.Control getControl(List<String> formats)

Returns a control according to formats.

getNoFallbackControl

public static ResourceBundle.Control getNoFallbackControl(List<String> formats)

Returns a control according to formats whose fallback locale is null.

getCandidateLocales

public List<Locale> getCandidateLocales(String baseName,
                                        Locale locale)

Returns a list of candidate locales according to baseName in locale.

getFormats

public List<String> getFormats(String baseName)

Returns a list of strings of formats according to baseName.

getFallbackLocale

public Locale getFallbackLocale(String baseName,
                                Locale locale)

Returns the fallback locale for baseName in locale.

newBundle

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

Returns a new ResourceBundle.

Parameters:

baseName - the base name to use

locale - the given locale

format - the format, default is "java.class" or "java.properties"

loader - the classloader to use

reload - whether to reload the resource

Returns:

a new ResourceBundle according to the give parameters

Throws:

IllegalAccessException - if we can not access resources

InstantiationException - if we can not instantiate a resource class

IOException - if other I/O exception happens

getTimeToLive

public long getTimeToLive(String baseName,
                          Locale locale)

Returns the time to live of the ResourceBundle baseName in locale, default is TTL_NO_EXPIRATION_CONTROL.

needsReload

public boolean needsReload(String baseName,
                           Locale locale,
                           String format,
                           ClassLoader loader,
                           ResourceBundle bundle,
                           long loadTime)

Returns true if the ResourceBundle needs to reload.

Parameters:

baseName - the base name of the ResourceBundle

locale - the locale of the ResourceBundle

format - the format to load

loader - the ClassLoader to load resource

bundle - the ResourceBundle

loadTime - the expired time

Returns:

if the ResourceBundle needs to reload

toBundleName

public String toBundleName(String baseName,
                           Locale locale)

a utility method to answer the name of a resource bundle according to the given base name and locale

Parameters:

baseName - the given base name

locale - the locale to use

Returns:

the name of a resource bundle according to the given base name and locale

toResourceName

public final String toResourceName(String bundleName,
                                   String suffix)

a utility method to answer the name of a resource according to the given bundleName and suffix

Parameters:

bundleName - the given bundle name

suffix - the suffix

Returns:

the name of a resource according to the given bundleName and suffix