com.ibm.icu.util

Enum CodePointMap.RangeOption

java.lang.Object

java.lang.Enum<CodePointMap.RangeOption>

com.ibm.icu.util.CodePointMap.RangeOption

All Implemented Interfaces:

Serializable, Comparable<CodePointMap.RangeOption>

Enclosing class:

CodePointMap

public static enum CodePointMap.RangeOption
extends Enum<CodePointMap.RangeOption>

Selectors for how getRange() should report value ranges overlapping with surrogates. Most users should use NORMAL.

See Also:

CodePointMap.getRange(int, com.ibm.icu.util.CodePointMap.ValueFilter, com.ibm.icu.util.CodePointMap.Range)

Status:

Stable ICU 63.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIXED_ALL_SURROGATES getRange() enumerates all same-value ranges as stored in the map, except that all surrogates (U+D800..U+DFFF) are treated as having the surrogateValue, which is passed to getRange() as a separate parameter.
FIXED_LEAD_SURROGATES getRange() enumerates all same-value ranges as stored in the map, except that lead surrogates (U+D800..U+DBFF) are treated as having the surrogateValue, which is passed to getRange() as a separate parameter.
NORMAL getRange() enumerates all same-value ranges as stored in the map.

Method Summary

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

NORMAL

public static final CodePointMap.RangeOption NORMAL

getRange() enumerates all same-value ranges as stored in the map. Most users should use this option.

Status:

Stable ICU 63.

FIXED_LEAD_SURROGATES

public static final CodePointMap.RangeOption FIXED_LEAD_SURROGATES

getRange() enumerates all same-value ranges as stored in the map, except that lead surrogates (U+D800..U+DBFF) are treated as having the surrogateValue, which is passed to getRange() as a separate parameter. The surrogateValue is not transformed via filter(). See Character.isHighSurrogate(char).

Most users should use NORMAL instead.

This option is useful for maps that map surrogate code units to special values optimized for UTF-16 string processing or for special error behavior for unpaired surrogates, but those values are not to be associated with the lead surrogate code points.

Status:

Stable ICU 63.

FIXED_ALL_SURROGATES

public static final CodePointMap.RangeOption FIXED_ALL_SURROGATES

getRange() enumerates all same-value ranges as stored in the map, except that all surrogates (U+D800..U+DFFF) are treated as having the surrogateValue, which is passed to getRange() as a separate parameter. The surrogateValue is not transformed via filter(). See Character.isSurrogate(char).

Most users should use NORMAL instead.

This option is useful for maps that map surrogate code units to special values optimized for UTF-16 string processing or for special error behavior for unpaired surrogates, but those values are not to be associated with the lead surrogate code points.

Status:

Stable ICU 63.

Method Detail

values

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

Returns:

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

valueOf

public static CodePointMap.RangeOption 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