com.ibm.icu.text

Enum PersonNameFormatter.Length

java.lang.Object

java.lang.Enum<PersonNameFormatter.Length>

com.ibm.icu.text.PersonNameFormatter.Length

All Implemented Interfaces:

Serializable, Comparable<PersonNameFormatter.Length>

Enclosing class:

PersonNameFormatter

public static enum PersonNameFormatter.Length
extends Enum<PersonNameFormatter.Length>

Specifies the desired length of the formatted name.

Status:

Stable ICU 73.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DEFAULT The default name length for the locale.
LONG The longest name length.
MEDIUM The most typical name length.
SHORT A shortened name.

Method Summary

Modifier and Type	Method and Description
static PersonNameFormatter.Length	valueOf(String name) Returns the enum constant of this type with the specified name.
static PersonNameFormatter.Length[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LONG

public static final PersonNameFormatter.Length LONG

The longest name length. Generally uses most of the fields in the name object.

Status:

Stable ICU 73.

MEDIUM

public static final PersonNameFormatter.Length MEDIUM

The most typical name length. Generally includes the given name and surname, but generally not most of the other fields.

Status:

Stable ICU 73.

SHORT

public static final PersonNameFormatter.Length SHORT

A shortened name. Skips most fields and may abbreviate some name fields to just their initials. When Formality is INFORMAL, may only include one field.

Status:

Stable ICU 73.

DEFAULT

public static final PersonNameFormatter.Length DEFAULT

The default name length for the locale. For most locales, this is the same as MEDIUM.

Status:

Stable ICU 74.

Method Detail

values

public static PersonNameFormatter.Length[] values()

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 (PersonNameFormatter.Length c : PersonNameFormatter.Length.values())
    System.out.println(c);

Returns:

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

valueOf

public static PersonNameFormatter.Length valueOf(String name)

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