com.ibm.icu.text

Enum PersonName.NameField

java.lang.Object

java.lang.Enum<PersonName.NameField>

com.ibm.icu.text.PersonName.NameField

All Implemented Interfaces:

Serializable, Comparable<PersonName.NameField>

Enclosing interface:

PersonName

Deprecated.

This API is for technology preview only.

@Deprecated
public static enum PersonName.NameField
extends Enum<PersonName.NameField>

Identifiers for the name fields supported by the PersonName object.

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
GIVEN Deprecated. This API is for technology preview only.
GIVEN2 Deprecated. This API is for technology preview only.
PREFERRED_ORDER Deprecated. This API is for technology preview only.
PREFIX Deprecated. This API is for technology preview only.
SUFFIX Deprecated. This API is for technology preview only.
SURNAME Deprecated. This API is for technology preview only.
SURNAME2 Deprecated. This API is for technology preview only.

Method Summary

Modifier and Type	Method and Description
static PersonName.NameField	forString(String name) Deprecated. This API is for ICU internal use only.
String	toString() Deprecated. This API is for technology preview only.
static PersonName.NameField	valueOf(String name) Deprecated. Returns the enum constant of this type with the specified name.
static PersonName.NameField[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PREFIX

@Deprecated
public static final PersonName.NameField PREFIX

Deprecated. This API is for technology preview only.

Contains titles and other words that precede the actual name, such as "Mr."

Status:

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

GIVEN

@Deprecated
public static final PersonName.NameField GIVEN

Deprecated. This API is for technology preview only.

The given name. May contain more than one token.

Status:

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

GIVEN2

@Deprecated
public static final PersonName.NameField GIVEN2

Deprecated. This API is for technology preview only.

Additional given names. (In English, this is usually the "middle name" and may contain more than one word.)

Status:

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

SURNAME

@Deprecated
public static final PersonName.NameField SURNAME

Deprecated. This API is for technology preview only.

The surname. In Spanish, this is the patronymic surname.

Status:

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

SURNAME2

@Deprecated
public static final PersonName.NameField SURNAME2

Deprecated. This API is for technology preview only.

Additional surnames. This is only used in a few languages, such as Spanish, where it is the matronymic surname. (In most languages, multiple surnames all just go in the SURNAME field.)

Status:

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

SUFFIX

@Deprecated
public static final PersonName.NameField SUFFIX

Deprecated. This API is for technology preview only.

Generational and professional qualifiers that generally follow the actual name, such as "Jr." or "M.D."

Status:

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

PREFERRED_ORDER

@Deprecated
public static final PersonName.NameField PREFERRED_ORDER

Deprecated. This API is for technology preview only.

The preferred field order for the name. PersonName objects generally shouldn't provide this field, allowing the PersonNameFormatter to deduce the proper field order based on the locales of the name of the formatter. But this can be used to force a particular field order, generally in cases where the deduction logic in PersonNameFormatter would guess wrong. When used, the only valid values are "givenFirst" and "surnameFirst".

Status:

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

Method Detail

values

public static PersonName.NameField[] 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 (PersonName.NameField c : PersonName.NameField.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.NameField 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

toString

@Deprecated
public String toString()

Deprecated. This API is for technology preview only.

Returns the NameField's display name.

Overrides:

toString in class Enum<PersonName.NameField>

Status:

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

forString

@Deprecated
public static PersonName.NameField forString(String name)

Deprecated. This API is for ICU internal use only.

Returns the appropriate NameField for its display name.

Status:

Internal. This API is ICU internal only.