com.ibm.icu.text

Enum BidiTransform.Order

java.lang.Object

java.lang.Enum<BidiTransform.Order>

com.ibm.icu.text.BidiTransform.Order

All Implemented Interfaces:

Serializable, Comparable<BidiTransform.Order>

Enclosing class:

BidiTransform

public static enum BidiTransform.Order
extends Enum<BidiTransform.Order>

BidiTransform.Order indicates the order of text.

This bidi transformation engine supports all possible combinations (4 in total) of input and output text order:

• {logical input, visual output}: unless the output direction is RTL, this corresponds to a normal operation of the Bidi algorithm as described in the Unicode Technical Report and implemented by Bidi when the reordering mode is set to Bidi#REORDER_DEFAULT. Visual RTL mode is not supported by Bidi and is accomplished through reversing a visual LTR string,
• {visual input, logical output}: unless the input direction is RTL, this corresponds to an "inverse bidi algorithm" in Bidi with the reordering mode set to Bidi.REORDER_INVERSE_LIKE_DIRECT. Visual RTL mode is not not supported by Bidi and is accomplished through reversing a visual LTR string,
• {logical input, logical output}: if the input and output base directions mismatch, this corresponds to the Bidi implementation with the reordering mode set to Bidi.REORDER_RUNS_ONLY; and if the input and output base directions are identical, the transformation engine will only handle character mirroring and Arabic shaping operations without reordering,
• {visual input, visual output}: this reordering mode is not supported by the Bidi engine; it implies character mirroring, Arabic shaping, and - if the input/output base directions mismatch - string reverse operations.

See Also:

Bidi.setInverse(boolean), Bidi.setReorderingMode(int), Bidi.REORDER_DEFAULT, Bidi.REORDER_INVERSE_LIKE_DIRECT, Bidi.REORDER_RUNS_ONLY

Status:

Stable ICU 58.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOGICAL Constant indicating a logical order.
VISUAL Constant indicating a visual order.

Method Summary

Modifier and Type	Method and Description
static BidiTransform.Order	valueOf(String name) Returns the enum constant of this type with the specified name.
static BidiTransform.Order[]	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

LOGICAL

public static final BidiTransform.Order LOGICAL

Constant indicating a logical order.

Status:

Stable ICU 58.

VISUAL

public static final BidiTransform.Order VISUAL

Constant indicating a visual order.

Status:

Stable ICU 58.

Method Detail

values

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

Returns:

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

valueOf

public static BidiTransform.Order 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