Package com.ibm.icu.text
Enum PersonName.FieldModifier
- All Implemented Interfaces:
Serializable
,Comparable<PersonName.FieldModifier>
,java.lang.constant.Constable
- Enclosing interface:
- PersonName
Deprecated.
This API is for technology preview only.
Identifiers for the name field modifiers supported by the PersonName and PersonNameFormatter objects.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionDeprecated.This API is for technology preview only.Deprecated.This API is for technology preview only.Deprecated.This API is for technology preview only.Deprecated.This API is for technology preview only.Deprecated.This API is for technology preview only.Deprecated.This API is for technology preview only.Deprecated.This API is for technology preview only. -
Method Summary
Modifier and TypeMethodDescriptionstatic PersonName.FieldModifier
Deprecated.This API is for technology preview only.toString()
Deprecated.This API is for technology preview only.static PersonName.FieldModifier
Deprecated.Returns the enum constant of this type with the specified name.static PersonName.FieldModifier[]
values()
Deprecated.Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
INFORMAL
Deprecated.This API is for technology preview only.Requests an "informal" variant of the field, generally a nickname of some type: if "given" is "James", "given-informal" might be "Jimmy". Only applied to the "given" field. If the PersonName object doesn't apply this modifier, PersonNameFormatter just uses the unmodified version of "given". -
PREFIX
Deprecated.This API is for technology preview only.If the field contains a main word with one or more separate prefixes, such as "van den Hul", this requests just the prefixes ("van den"). Only applied to the "surname" field. If the PersonName object doesn't apply this modifier, PersonNameFormatter assumes there are no prefixes. -
CORE
Deprecated.This API is for technology preview only.If the field contains a main word with one or more separate prefixes, such as "van den Hul", this requests just the main word ("Hul"). Only applied to the "surname" field. If the implementing class doesn't apply this modifier, PersonNameFormatter assumes the entire "surname" field is the "core". -
INITIAL
Deprecated.This API is for technology preview only.Requests an initial for the specified field. PersonNameFormatter will do this algorithmically, but a PersonName object can apply this modifier itself if it wants different initial-generation logic (or stores the initial separately). -
MONOGRAM
Deprecated.This API is for technology preview only.Requests an initial for the specified field, suitable for use in a monogram (this usually differs from "initial" in that "initial" often adds a period and "monogram" never does). PersonNameFormatter will do this algorithmically, but a PersonName object can apply this modifier itself if it wants different monogram-generation logic. -
ALL_CAPS
Deprecated.This API is for technology preview only.Requests the field value converted to ALL CAPS. PersonName objects generally won't need to handle this modifier themselves. -
INITIAL_CAP
Deprecated.This API is for technology preview only.Requests the field value with the first grapheme of each word converted to titlecase. A PersonName object might handle this modifier itself to capitalize words more selectively.
-
-
Method Details
-
values
Deprecated.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
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 nameNullPointerException
- if the argument is null
-
toString
Deprecated.This API is for technology preview only.Returns the FieldModifier's display name.- Overrides:
toString
in classEnum<PersonName.FieldModifier>
-
forString
Deprecated.This API is for technology preview only.Returns the appropriate fieldModifier for its display name.
-