org.graalvm.shadowed.com.ibm.icu.text

Enum PersonName.FieldModifier

java.lang.Object

java.lang.Enum<PersonName.FieldModifier>

org.graalvm.shadowed.com.ibm.icu.text.PersonName.FieldModifier

All Implemented Interfaces:

Serializable, Comparable<PersonName.FieldModifier>, java.lang.constant.Constable

Enclosing interface:

PersonName

public static enum PersonName.FieldModifier
extends Enum<PersonName.FieldModifier>

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 Constants

Enum Constant and Description
ALL_CAPS Requests the field value converted to ALL CAPS.
CORE 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").
GENITIVE Requests the genitive form of the field's contents, if possible.
INFORMAL Requests an "informal" variant of the field, generally a nickname of some type: if "given" is "James", "given-informal" might be "Jimmy".
INITIAL Requests an initial for the specified field.
INITIAL_CAP Requests the field value with the first grapheme of each word converted to titlecase.
MONOGRAM 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).
PREFIX 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").
VOCATIVE Requests the vocative form of the field's contents, if possible.

Method Summary

Modifier and Type	Method and Description
static PersonName.FieldModifier	forString(String name) Returns the appropriate fieldModifier for its display name.
String	toString() Returns the FieldModifier's display name.
static PersonName.FieldModifier	valueOf(String name) Returns the enum constant of this type with the specified name.
static PersonName.FieldModifier[]	values() 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, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INFORMAL

public static final PersonName.FieldModifier INFORMAL

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

public static final PersonName.FieldModifier PREFIX

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

public static final PersonName.FieldModifier CORE

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

public static final PersonName.FieldModifier INITIAL

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

public static final PersonName.FieldModifier MONOGRAM

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

public static final PersonName.FieldModifier ALL_CAPS

Requests the field value converted to ALL CAPS. PersonName objects generally won't need to handle this modifier themselves.

INITIAL_CAP

public static final PersonName.FieldModifier INITIAL_CAP

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.

GENITIVE

public static final PersonName.FieldModifier GENITIVE

Requests the genitive form of the field's contents, if possible. The default implementation does nothing, but subclasses of PersonName can override getFieldValue() to produce the genitive form (or just add an "xxx-genitive" entry to a SimplePersonName).

VOCATIVE

public static final PersonName.FieldModifier VOCATIVE

Requests the vocative form of the field's contents, if possible. The default implementation does nothing, but subclasses of PersonName can override getFieldValue() to produce the vocative form (or just add an "xxx-vocative" entry to a SimplePersonName).

Method Detail

values

public static PersonName.FieldModifier[] values()

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PersonName.FieldModifier valueOf(String name)

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

public String toString()

Returns the FieldModifier's display name.

Overrides:

toString in class Enum<PersonName.FieldModifier>

forString

public static PersonName.FieldModifier forString(String name)

Returns the appropriate fieldModifier for its display name.