com.ibm.icu.text

Class SimplePersonName

java.lang.Object

com.ibm.icu.text.SimplePersonName

All Implemented Interfaces:

PersonName

Deprecated.

This API is for technology preview only.

@Deprecated
public class SimplePersonName
extends Object
implements PersonName

A concrete implementation of PersonNameFormatter.PersonName that simply stores the field values in a Map. A caller can store both raw field values (such as "given") and modified field values (such as "given-informal") in a SimplePersonName. But beyond storing and returning modified field values provided to it by the caller, SimplePersonName relies on the PersonNameFormatter's default handling of field modifiers.

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimplePersonName.Builder Deprecated. This API is for technology preview only.

Nested classes/interfaces inherited from interface com.ibm.icu.text.PersonName

PersonName.FieldModifier, PersonName.NameField

Method Summary

Modifier and Type	Method and Description
static SimplePersonName.Builder	builder() Deprecated. This API is for technology preview only.
String	getFieldValue(PersonName.NameField nameField, Set<PersonName.FieldModifier> modifiers) Deprecated. This API is for technology preview only.
Locale	getNameLocale() Deprecated. This API is for technology preview only.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

@Deprecated
public static SimplePersonName.Builder builder()

Deprecated. This API is for technology preview only.

Returns a Builder object that can be used to construct a new SimplePersonName object.

Returns:

A Builder object that can be used to construct a new SimplePersonName object.

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

getNameLocale

@Deprecated
public Locale getNameLocale()

Deprecated. This API is for technology preview only.

Returns the locale of the name-- that is, the language or country of origin for the person being named.

Specified by:

getNameLocale in interface PersonName

Returns:

The name's locale, or null if it's unknown.

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.

getFieldValue

@Deprecated
public String getFieldValue(PersonName.NameField nameField,
                                        Set<PersonName.FieldModifier> modifiers)

Deprecated. This API is for technology preview only.

Returns one field of the name, possibly in a modified form. This class can store modified versions of fields, provided at construction time, and this function will return them. Otherwise, it ignores modifiers and relies on PersonNameFormat's default modifier handling.

Specified by:

getFieldValue in interface PersonName

Parameters:

nameField - The identifier of the requested field.

modifiers - An **IN/OUT** parameter that specifies modifiers to apply to the basic field value. On return, this list will contain any modifiers that this object didn't handle. This class will always return this set unmodified, unless a modified version of the requested field was provided at construction time.

Returns:

The value of the requested field, optionally modified by some or all of the requested modifiers, or null if the requested field isn't present in the name.

Status:

Technology Preview. This API is still in the early stages of development. Use at your own risk.