com.ibm.icu.text

Enum PersonName.PreferredOrder

java.lang.Object

java.lang.Enum<PersonName.PreferredOrder>

com.ibm.icu.text.PersonName.PreferredOrder

All Implemented Interfaces:

Serializable, Comparable<PersonName.PreferredOrder>

Enclosing interface:

PersonName

public static enum PersonName.PreferredOrder
extends Enum<PersonName.PreferredOrder>

An enum to specify the preferred field order for the name.

Status:

Stable ICU 73.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT Indicates the name has no preferred field order, and that the formatter should deduce the proper field order based on the locales of the name and the formatter.
GIVEN_FIRST Indicates that the name should be formatted in given-first order, even when the formatter would normally guess that it should be formatted in surname-first order.
SURNAME_FIRST Indicates that the name should be formatted in surname-first order, even when the formatter would normally guess that it should be formatted in given-first order.

Method Summary

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

DEFAULT

public static final PersonName.PreferredOrder DEFAULT

Indicates the name has no preferred field order, and that the formatter should deduce the proper field order based on the locales of the name and the formatter.

Status:

Stable ICU 73.

GIVEN_FIRST

public static final PersonName.PreferredOrder GIVEN_FIRST

Indicates that the name should be formatted in given-first order, even when the formatter would normally guess that it should be formatted in surname-first order.

Status:

Stable ICU 73.

SURNAME_FIRST

public static final PersonName.PreferredOrder SURNAME_FIRST

Indicates that the name should be formatted in surname-first order, even when the formatter would normally guess that it should be formatted in given-first order.

Status:

Stable ICU 73.

Method Detail

values

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

Returns:

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

valueOf

public static PersonName.PreferredOrder 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