Enum Directionality

java.lang.Object

java.lang.Enum<Directionality>

com.ibm.icu.message2.Directionality

All Implemented Interfaces:

Serializable, Comparable<Directionality>

public enum Directionality
extends Enum<Directionality>

Encodes info about the direction of the message.

It is used to implement the @code u:dir} functionality.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO	Directionality determined from expression contents.
INHERIT	Directionality inherited from the message or from the resolved value of the operand without requiring isolation of the expression value.
LTR	Left-to-right directionality.
RTL	Right-to-left directionality.
UNKNOWN	Not initialized or unknown.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Directionality()

Method Summary

Modifier and Type	Method	Description
static Directionality	of(Locale locale)	Determines the directionality appropriate for a given locale.
static Directionality	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Directionality[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNKNOWN

public static final Directionality UNKNOWN

Not initialized or unknown.

No special processing will be used.

LTR

public static final Directionality LTR

Left-to-right directionality.

RTL

public static final Directionality RTL

Right-to-left directionality.

AUTO

public static final Directionality AUTO

Directionality determined from expression contents.

INHERIT

public static final Directionality INHERIT

Directionality inherited from the message or from the resolved value of the operand without requiring isolation of the expression value.

Constructor Details

Directionality

private Directionality()

Method Details

values

public static Directionality[] 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 Directionality 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

of

public static Directionality of(Locale locale)

Determines the directionality appropriate for a given locale.

Parameters:

locale - the locale to determine the directionality from.

Returns:

the appropriate directionality for the locale given.