oracle.javatools.util

Class TranslationControl

java.lang.Object

java.util.ResourceBundle.Control

oracle.javatools.util.TranslationControl

public class TranslationControl
extends java.util.ResourceBundle.Control

Subclass of ResourceBundle.Control that optimizes the loading of resources based on the knowledge of which locales the resources have been translated to. An instance of TranslationControl is constructed providing the available locales in a String object separated by commas. When an instance of TranslationControl is passed to one of the getBundle methods of ResourceBundle, the overridden getCandidateLocales(java.lang.String, java.util.Locale) restricts the target locale to be compatible to one of those specified at contruction time, in order to minimize the time spent looking for non existent resources. TranslationControl accepts the same resource formats as its superclass ResourceBundle.Control does. If other formats are required, TranslationControl must be subclassed and the relevant methods must be overriden.

Field Summary

Fields inherited from class java.util.ResourceBundle.Control

FORMAT_CLASS, FORMAT_DEFAULT, FORMAT_PROPERTIES, TTL_DONT_CACHE, TTL_NO_EXPIRATION_CONTROL

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TranslationControl(java.util.Locale targetLocale, java.util.List<java.lang.String> formats, java.lang.String translations) Creates an instance of TranslationControl.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.util.Locale>	getCandidateLocales(java.lang.String baseName, java.util.Locale locale) Returns a list of candidate locales give the specified target locale.
static TranslationControl	getClassFormatTranslationControl() Returns the singleton instance of TranslationControl that handles the java class format for resources.
static TranslationControl	getDefaultFormatTranslationControl() Returns the singleton instance of TranslationControl that handles both the java class and java properties formats.
java.util.Locale	getFallbackLocale(java.lang.String baseName, java.util.Locale locale) Returns the fallback locale.
java.util.List<java.lang.String>	getFormats(java.lang.String baseName) Returns the resource formats specified at construction time.
static TranslationControl	getPropertiesFormatTranslationControl() Returns the singleton instance of TranslationControl that handles the java properties format for resources.

Methods inherited from class java.util.ResourceBundle.Control

getControl, getNoFallbackControl, getTimeToLive, needsReload, newBundle, toBundleName, toResourceName

Methods inherited from class java.lang.Object

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

Constructor Detail

TranslationControl

protected TranslationControl(java.util.Locale targetLocale,
                  java.util.List<java.lang.String> formats,
                  java.lang.String translations)

Creates an instance of TranslationControl. The argument translations provides the available locales in a comma-separated list, like, for example, "en_US, ja". If the argument is null, then getCandidateLocales(java.lang.String, java.util.Locale) doesn't make any attempt to restrict the locale; if it is an empty String, TranslationControl#getCandidateLocales restricts the locale to the Locale.ROOT one. If the targetLocale argument is null the default locale will used as target locale.

Parameters:

targetLocale - the target locale, can be null

translations - a String with the comma-separated list of locales, can be null

Method Detail

getCandidateLocales

public java.util.List<java.util.Locale> getCandidateLocales(java.lang.String baseName,
                                                   java.util.Locale locale)

Returns a list of candidate locales give the specified target locale. Overrides the {@code Resourcebundle.Control#getCandidateLocales to ensure that the candidate locales are compatible with the list of locales specified at construction. If no list of available locales were specified, this method just delegate the job to the superclass.

Overrides:

getCandidateLocales in class java.util.ResourceBundle.Control

Parameters:

baseName - the base name of the resource, it must not be null

locale - the target locale

Returns:

a List<String> containing the candidate locales

getFallbackLocale

public java.util.Locale getFallbackLocale(java.lang.String baseName,
                                 java.util.Locale locale)

Returns the fallback locale. If a list of available locales were specified at construction, then this method returns null, as there is no need for a fall back locale because the getCandidateLocales method ensures that the locale matches one of those for which the resource are available. Otherwise, it calls the superclass' method.

Overrides:

getFallbackLocale in class java.util.ResourceBundle.Control

Parameters:

baseName - the base name of the resource, it must not be null

locale - the target locale

Returns:

the fallback locale or null

getFormats

public java.util.List<java.lang.String> getFormats(java.lang.String baseName)

Returns the resource formats specified at construction time.

Overrides:

getFormats in class java.util.ResourceBundle.Control

Parameters:

baseName - the base name of the resource, it must not be null

Returns:

a List of String objects representing the resource formats.

getClassFormatTranslationControl

public static TranslationControl getClassFormatTranslationControl()

Returns the singleton instance of TranslationControl that handles the java class format for resources.

Returns:

the TranslationControl instance, it is never null

getPropertiesFormatTranslationControl

public static TranslationControl getPropertiesFormatTranslationControl()

Returns the singleton instance of TranslationControl that handles the java properties format for resources.

Returns:

the TranslationControl instance, it is never null

getDefaultFormatTranslationControl

public static TranslationControl getDefaultFormatTranslationControl()

Returns the singleton instance of TranslationControl that handles both the java class and java properties formats.

Returns:

the TranslationControl instance, it is never null