com.force.i18n

Enum LanguageProviderFactory

java.lang.Object

java.lang.Enum<LanguageProviderFactory>

com.force.i18n.LanguageProviderFactory

All Implemented Interfaces:

LanguageProvider, Serializable, Comparable<LanguageProviderFactory>

public enum LanguageProviderFactory
extends Enum<LanguageProviderFactory>
implements LanguageProvider

Provides access to a "renaming" provider that is global to the application

Author:

stamm

Nested Class Summary

Nested classes/interfaces inherited from interface com.force.i18n.LanguageProvider

LanguageProvider.Helper

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
static LanguageProviderFactory	get()
List<? extends HumanLanguage>	getAll()
HumanLanguage	getBaseLanguage()
HumanLanguage	getLanguage(Locale loc)
HumanLanguage	getLanguage(String isoCode)
HumanLanguage	getLanguageForLocale(Locale loc)
HumanLanguage	getLanguageForLocale(String localeString)
<L extends HumanLanguage,T> Map<L,T>	getNewMap()
LanguageProvider	getProvider()
boolean	isSupportedLanguageLocale(Locale loc)
void	setProvider(LanguageProvider provider)
static LanguageProviderFactory	valueOf(String name) Returns the enum constant of this type with the specified name.
static LanguageProviderFactory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final LanguageProviderFactory INSTANCE

Method Detail

values

public static LanguageProviderFactory[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LanguageProviderFactory c : LanguageProviderFactory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static LanguageProviderFactory valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

get

public static LanguageProviderFactory get()

setProvider

public void setProvider(LanguageProvider provider)

getProvider

public LanguageProvider getProvider()

getAll

public List<? extends HumanLanguage> getAll()

Specified by:

getAll in interface LanguageProvider

Returns:

the set of all languages supported by this provider

getBaseLanguage

public HumanLanguage getBaseLanguage()

Specified by:

getBaseLanguage in interface LanguageProvider

Returns:

the language that is the "base" for all labels. This assumes that the entire application is localized into a single language, and then translated into the others. If this language isn't "English", some things might not work. Note: This doesn't apply to "Renameable" things

getLanguage

public HumanLanguage getLanguage(Locale loc)

Specified by:

getLanguage in interface LanguageProvider

Returns:

the User Language associated directly with a locale (including country and variant)

getLanguage

public HumanLanguage getLanguage(String isoCode)

Specified by:

getLanguage in interface LanguageProvider

Returns:

the User Language associated directly with a locale (including country and variant)

isSupportedLanguageLocale

public boolean isSupportedLanguageLocale(Locale loc)

Specified by:

isSupportedLanguageLocale in interface LanguageProvider

Returns:

true if the given locale is a support user language locale

getLanguageForLocale

public HumanLanguage getLanguageForLocale(String localeString)

Specified by:

getLanguageForLocale in interface LanguageProvider

Returns:

the closest HumanLanguage to the given locale string, taking into account various factors

getLanguageForLocale

public HumanLanguage getLanguageForLocale(Locale loc)

Specified by:

getLanguageForLocale in interface LanguageProvider

Returns:

the closest HumanLanguage to the given locale, taking into account various factors

getNewMap

public <L extends HumanLanguage,T> Map<L,T> getNewMap()

Specified by:

getNewMap in interface LanguageProvider

Returns:

a map with an optimized implementation for the given map