Package de.xima.fc.mdl.enums

Enum ELanguage

java.lang.Object

java.lang.Enum<ELanguage>

de.xima.fc.mdl.enums.ELanguage

All Implemented Interfaces:

INamedUiElement, Serializable, Comparable<ELanguage>

public enum ELanguage
extends Enum<ELanguage>
implements INamedUiElement

Supported default languages for the formcycle backend.

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
DE
EN
IT
NL

Field Summary

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Method Summary

Modifier and Type	Method	Description
static ELanguage[]	all()	Deprecated. Use values().
static ELanguage	getByLocale(Locale locale)	Finds the best ELanguage for the given locale.
String	getDisplayName(Locale l)	The display name of this element in the given locale.
Locale	getLocale()
static Locale	getSupportedLocale(Locale candidate)	Gets the supported locale for the given locale candidate if possible.
static ELanguage	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ELanguage	valueOfOrNull(String string)
static ELanguage[]	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

DE

public static final ELanguage DE

EN

public static final ELanguage EN

NL

public static final ELanguage NL

IT

public static final ELanguage IT

Method Detail

values

public static ELanguage[] 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 (ELanguage c : ELanguage.values())
    System.out.println(c);

Returns:

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

valueOf

public static ELanguage 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

getDisplayName

public String getDisplayName(Locale l)

Description copied from interface: INamedUiElement

The display name of this element in the given locale.

Specified by:

getDisplayName in interface INamedUiElement

Parameters:

l - The locale to get the display name for.

Returns:

The display name of this element in the given locale.

getLocale

public Locale getLocale()

all

@Deprecated
public static ELanguage[] all()

Deprecated.

Use values().

Returns:

A list of all enum members.

getByLocale

public static ELanguage getByLocale(Locale locale)

Finds the best ELanguage for the given locale. If no exact match can be found, the language with the matching language code is returned, if any (e.g. EN for the locale en_US).

Parameters:

locale - Locale to check.

Returns:

The ELanguage that best matches the given locale, or null if no language matches at all.

valueOfOrNull

public static ELanguage valueOfOrNull(String string)

getSupportedLocale

@Nullable
public static Locale getSupportedLocale(Locale candidate)

Gets the supported locale for the given locale candidate if possible. Countries & variants of the locale are ignored. E.g. if a locale candidate de_DE is given then the supported locale de will be returned.

Parameters:

candidate - locale to determine the supported locale for.

Returns:

the supported locale for the given candidate or null if none could be found.