Package com.ibm.icu.text
Enum PersonNameFormatter.Usage
- All Implemented Interfaces:
Serializable
,Comparable<PersonNameFormatter.Usage>
,java.lang.constant.Constable
- Enclosing class:
PersonNameFormatter
Specifies the intended usage of the formatted name.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionUsed for when the name is going to be used to address the user directly: "Turn left here, John."Used to generate monograms, short 1 to 3-character versions of the name suitable for use in things like chat avatars.Used in general cases, when the name is used to refer to somebody else. -
Method Summary
Modifier and TypeMethodDescriptionstatic PersonNameFormatter.Usage
Returns the enum constant of this type with the specified name.static PersonNameFormatter.Usage[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
ADDRESSING
Used for when the name is going to be used to address the user directly: "Turn left here, John." -
REFERRING
Used in general cases, when the name is used to refer to somebody else. -
MONOGRAM
Used to generate monograms, short 1 to 3-character versions of the name suitable for use in things like chat avatars. In English, this is usually the person's initials, but this isn't true in all languages. When the caller specifies Usage.MONOGRAM, the Length parameter can be used to get different lengths of monograms: Length.SHORT is generally a single letter; Length.LONG may be as many as three or four.
-
-
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
-