Package com.ibm.icu.text
Enum PersonName.NameField
- All Implemented Interfaces:
Serializable
,Comparable<PersonName.NameField>
,java.lang.constant.Constable
- Enclosing interface:
PersonName
Identifiers for the name fields supported by the PersonName object.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionProfessional qualifiers that in English generally follow the actual name, such as "M.D." or "J.D.".Generational qualifiers that in English generally follow the actual name, such as "Jr." or "III".The given name.Additional given names.The surname.Additional surnames.Contains titles such as "Mr.", "Dr." -
Method Summary
Modifier and TypeMethodDescriptionstatic PersonName.NameField
Deprecated.This API is for ICU internal use only.toString()
Returns the NameField's display name.static PersonName.NameField
Returns the enum constant of this type with the specified name.static PersonName.NameField[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
TITLE
Contains titles such as "Mr.", "Dr." (in English these typically precede the name) -
GIVEN
The given name. May contain more than one token. -
GIVEN2
Additional given names. (In English, this is usually the "middle name" and may contain more than one word.) -
SURNAME
The surname. In Spanish, this is the patronymic surname. -
SURNAME2
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.) -
GENERATION
Generational qualifiers that in English generally follow the actual name, such as "Jr." or "III". -
CREDENTIALS
Professional qualifiers that in English generally follow the actual name, such as "M.D." or "J.D.".
-
-
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
-
toString
Returns the NameField's display name.- Overrides:
toString
in classEnum<PersonName.NameField>
-
forString
Deprecated.This API is for ICU internal use only.Returns the appropriate NameField for its display name.
-