Package com.ibm.icu.text
Enum PersonNameFormatter.DisplayOrder
- All Implemented Interfaces:
Serializable
,Comparable<PersonNameFormatter.DisplayOrder>
,java.lang.constant.Constable
- Enclosing class:
- PersonNameFormatter
An enum indicating the desired display order for a formatted name.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe default display order; used to indicate normal formatting.Forces the formatter to format the name in given-first order.Forces the formatter to format the name in surname-first order.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". -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns 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.
-
Enum Constant Details
-
DEFAULT
The default display order; used to indicate normal formatting. -
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". -
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. -
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.
-
-
Constructor Details
-
DisplayOrder
private DisplayOrder()
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException
- if the argument is null
-