com.ibm.icu.text

Enum PersonNameFormatter.DisplayOrder

java.lang.Object

java.lang.Enum<PersonNameFormatter.DisplayOrder>

com.ibm.icu.text.PersonNameFormatter.DisplayOrder

All Implemented Interfaces:

Serializable, Comparable<PersonNameFormatter.DisplayOrder>

Enclosing class:

PersonNameFormatter

public static enum PersonNameFormatter.DisplayOrder
extends Enum<PersonNameFormatter.DisplayOrder>

An enum indicating the desired display order for a formatted name.

Status:

Stable ICU 73.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT The default display order; used to indicate normal formatting.
FORCE_GIVEN_FIRST Forces the formatter to format the name in given-first order.
FORCE_SURNAME_FIRST Forces the formatter to format the name in surname-first order.
SORTING Used to indicate a display order suitable for use in a sorted list: For English, this would put the surnames first, with a comma between them and the rest of the name: "Smith, John".

Method Summary

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

The default display order; used to indicate normal formatting.

Status:

Stable ICU 73.

SORTING

public static final PersonNameFormatter.DisplayOrder SORTING

Used to indicate a display order suitable for use in a sorted list: For English, this would put the surnames first, with a comma between them and the rest of the name: "Smith, John".

Status:

Stable ICU 73.

FORCE_GIVEN_FIRST

public static final PersonNameFormatter.DisplayOrder FORCE_GIVEN_FIRST

Forces the formatter to format the name in given-first order. If the name itself specifies a display order, this overrides it.

Status:

Stable ICU 74.

FORCE_SURNAME_FIRST

public static final PersonNameFormatter.DisplayOrder FORCE_SURNAME_FIRST

Forces the formatter to format the name in surname-first order. If the name itself specifies a display order, this overrides it.

Status:

Stable ICU 74.

Method Detail

values

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

Returns:

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

valueOf

public static PersonNameFormatter.DisplayOrder 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