com.frostphyr.avail.text

Enum SurrogatePairPolicy

java.lang.Object

java.lang.Enum<SurrogatePairPolicy>

com.frostphyr.avail.text.SurrogatePairPolicy

All Implemented Interfaces:

Serializable, Comparable<SurrogatePairPolicy>

public enum SurrogatePairPolicy
extends Enum<SurrogatePairPolicy>

Indicates how to handle surrogate pairs during text operations when the operation would normally split the pair.

Since:

1.5

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISCARD The entire pair, including the low and high surrogate, will be discarded.
KEEP The entire pair, including the low and high surrogate, will be kept.
SPLIT Splits the surrogate pair, causing undefined or incorrect Unicode characters.

Method Summary

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

SPLIT

public static final SurrogatePairPolicy SPLIT

Splits the surrogate pair, causing undefined or incorrect Unicode characters.

KEEP

public static final SurrogatePairPolicy KEEP

The entire pair, including the low and high surrogate, will be kept.

DISCARD

public static final SurrogatePairPolicy DISCARD

The entire pair, including the low and high surrogate, will be discarded.

Method Detail

values

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

Returns:

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

valueOf

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