com.ibm.icu.text

Enum PersonNameFormatter.Options

java.lang.Object

java.lang.Enum<PersonNameFormatter.Options>

com.ibm.icu.text.PersonNameFormatter.Options

All Implemented Interfaces:

Serializable, Comparable<PersonNameFormatter.Options>

Enclosing class:

PersonNameFormatter

Deprecated.

This API is for technology preview only.

@Deprecated
public static enum PersonNameFormatter.Options
extends Enum<PersonNameFormatter.Options>

Additional options to customize the behavior of the formatter.

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SORTING Deprecated. This API is for technology preview only.
SURNAME_ALLCAPS Deprecated. This API is for technology preview only.

Method Summary

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

SORTING

@Deprecated
public static final PersonNameFormatter.Options SORTING

Deprecated. This API is for technology preview only.

Causes the formatter to generate results suitable for inclusion in a sorted list. For GN-first languages, this generally means moving the surname to the beginning of the string, with a comma between it and the rest of the name: e.g., "Carter, James E. Jr.".

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

SURNAME_ALLCAPS

@Deprecated
public static final PersonNameFormatter.Options SURNAME_ALLCAPS

Deprecated. This API is for technology preview only.

Requests that the surname in the formatted result be rendered in ALL CAPS. This is often done with Japanese names to highlight which name is the surname.

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

Method Detail

values

public static PersonNameFormatter.Options[] values()

Deprecated.

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.Options c : PersonNameFormatter.Options.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.Options valueOf(String name)

Deprecated.

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