Enum LanguageFormType

java.lang.Object

java.lang.Enum<LanguageFormType>

com.lokalized.LanguageFormType

All Implemented Interfaces:

Serializable, Comparable<LanguageFormType>, Constable

public enum LanguageFormType
extends Enum<LanguageFormType>

High-level categories of language forms used to drive placeholder agreement.

These values correspond to the JSON form names used by selector-based placeholder translations, for example GENDER or CASE.

Author:

Mark Allen

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANIMACY	Animacy form.
CARDINALITY	Cardinality/plural form.
CASE	Grammatical case form.
CLASSIFIER	Classifier or counter-word form.
CLUSIVITY	Clusivity form.
DEFINITENESS	Definiteness form.
FORMALITY	Speech-level or formality form.
GENDER	Grammatical gender form.
ORDINALITY	Ordinality/ordinal-number form.
PHONETIC	Phonetic form.

Method Summary

Modifier and Type	Method	Description
static @NonNull LanguageFormType	forLanguageForm(@NonNull LanguageForm languageForm)	Determines the selector-form type for a concrete language-form value.
@NonNull Class<? extends LanguageForm>	getLanguageFormClass()	Gets the concrete LanguageForm class represented by this type.
static LanguageFormType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static LanguageFormType[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CARDINALITY

public static final LanguageFormType CARDINALITY

Cardinality/plural form.

ORDINALITY

public static final LanguageFormType ORDINALITY

Ordinality/ordinal-number form.

GENDER

public static final LanguageFormType GENDER

Grammatical gender form.

CASE

public static final LanguageFormType CASE

Grammatical case form.

DEFINITENESS

public static final LanguageFormType DEFINITENESS

Definiteness form.

CLASSIFIER

public static final LanguageFormType CLASSIFIER

Classifier or counter-word form.

FORMALITY

public static final LanguageFormType FORMALITY

Speech-level or formality form.

CLUSIVITY

public static final LanguageFormType CLUSIVITY

Clusivity form.

ANIMACY

public static final LanguageFormType ANIMACY

Animacy form.

PHONETIC

public static final LanguageFormType PHONETIC

Phonetic form.

Method Details

values

public static LanguageFormType[] values()

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

Returns:

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

valueOf

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

getLanguageFormClass

public @NonNull Class<? extends LanguageForm> getLanguageFormClass()

Gets the concrete LanguageForm class represented by this type.

Returns:

the concrete LanguageForm class represented by this type, not null

forLanguageForm

public static @NonNull LanguageFormType forLanguageForm(@NonNull LanguageForm languageForm)

Determines the selector-form type for a concrete language-form value.

Parameters:

languageForm - the language-form value for which to determine a type, not null

Returns:

the selector-form type for the supplied language-form value, not null

Throws:

IllegalArgumentException - if the language form is not recognized