PersonName.FieldModifier (ICU4J (com.ibm.icu:icu4j) 72.1)

java.lang.Object
- java.lang.Enum<PersonName.FieldModifier>
- - com.ibm.icu.text.PersonName.FieldModifier

All Implemented Interfaces:

Serializable, Comparable<PersonName.FieldModifier>

Enclosing interface:

PersonName

Deprecated.
This API is for technology preview only.
```
@Deprecated
public static enum PersonName.FieldModifier
extends Enum<PersonName.FieldModifier>
```
Identifiers for the name field modifiers supported by the PersonName and PersonNameFormatter objects.

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
`ALL_CAPS` Deprecated. This API is for technology preview only.
`CORE` Deprecated. This API is for technology preview only.
`INFORMAL` Deprecated. This API is for technology preview only.
`INITIAL` Deprecated. This API is for technology preview only.
`INITIAL_CAP` Deprecated. This API is for technology preview only.
`MONOGRAM` Deprecated. This API is for technology preview only.
`PREFIX` Deprecated. This API is for technology preview only.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static PersonName.FieldModifier`	`forString(String name)` Deprecated. This API is for technology preview only.
`String`	`toString()` Deprecated. This API is for technology preview only.
`static PersonName.FieldModifier`	`valueOf(String name)` 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.

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
  - INFORMAL
```
@Deprecated
public static final PersonName.FieldModifier 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".
    
    Status:
    Technology Preview. This API is still in the early stages of development. Use at your own risk.
  - PREFIX
```
@Deprecated
public static final PersonName.FieldModifier 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.
    
    Status:
    Technology Preview. This API is still in the early stages of development. Use at your own risk.
  - CORE
```
@Deprecated
public static final PersonName.FieldModifier 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".
    
    Status:
    Technology Preview. This API is still in the early stages of development. Use at your own risk.
  - INITIAL
```
@Deprecated
public static final PersonName.FieldModifier 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).
    
    Status:
    Technology Preview. This API is still in the early stages of development. Use at your own risk.
  - MONOGRAM
```
@Deprecated
public static final PersonName.FieldModifier 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.
    
    Status:
    Technology Preview. This API is still in the early stages of development. Use at your own risk.
  - ALL_CAPS
```
@Deprecated
public static final PersonName.FieldModifier 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.
    
    Status:
    Technology Preview. This API is still in the early stages of development. Use at your own risk.
  - INITIAL_CAP
```
@Deprecated
public static final PersonName.FieldModifier 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.
    
    Status:
    Technology Preview. This API is still in the early stages of development. Use at your own risk.
- Method Detail
  - values
```
public static PersonName.FieldModifier[] 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.FieldModifier c : PersonName.FieldModifier.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.FieldModifier 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 FieldModifier's display name.
    
    Overrides:
    
    toString in class Enum<PersonName.FieldModifier>
    
    Status:
    Technology Preview. This API is still in the early stages of development. Use at your own risk.
  - forString
```
@Deprecated
public static PersonName.FieldModifier forString(String name)
```
    Deprecated. This API is for technology preview only.
    
    Returns the appropriate fieldModifier for its display name.
    
    Status:
    Technology Preview. This API is still in the early stages of development. Use at your own risk.

Enum PersonName.FieldModifier

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INFORMAL

PREFIX

CORE

INITIAL

MONOGRAM

ALL_CAPS

INITIAL_CAP

Method Detail

values

valueOf

toString

forString