com.ibm.icu.text

Class PersonNameFormatter

java.lang.Object

com.ibm.icu.text.PersonNameFormatter

Deprecated.

This API is for technology preview only.

@Deprecated
public class PersonNameFormatter
extends Object

A class for formatting names of people. Takes raw name data for a person and renders it into a string according to the caller's specifications, taking into account how people's names are rendered in the caller's locale. The Length, Usage, and Formality options can be used to get a wide variety of results. In English, they would produce results along these lines:

	REFERRING		ADDRESSING		MONOGRAM
	FORMAL	INFORMAL	FORMAL	INFORMAL	FORMAL	INFORMAL
LONG	James Earl Carter Jr.	Jimmy Carter	Mr. Carter	Jimmy	JEC	JC
MEDIUM	James E. Carter Jr.	Jimmy Carter	Mr. Carter	Jimmy	C	J
SHORT	J. E. Carter	Jimmy Carter	Mr. Carter	Jimmy	C	J

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	PersonNameFormatter.Builder Deprecated. This API is for technology preview only.
static class	PersonNameFormatter.Formality Deprecated. This API is for technology preview only.
static class	PersonNameFormatter.Length Deprecated. This API is for technology preview only.
static class	PersonNameFormatter.Options Deprecated. This API is for technology preview only.
static class	PersonNameFormatter.Usage Deprecated. This API is for technology preview only.

Constructor Summary

Constructors

Constructor and Description
PersonNameFormatter(Locale locale, String[] patterns) Deprecated. This API is for unit testing only.

Method Summary

Modifier and Type	Method and Description
static PersonNameFormatter.Builder	builder() Deprecated. This API is for technology preview only.
String	formatToString(PersonName name) Deprecated. This API is for technology preview only.
PersonNameFormatter.Builder	toBuilder() 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

Constructor Detail

PersonNameFormatter

@Deprecated
public PersonNameFormatter(Locale locale,
                                       String[] patterns)

Deprecated. This API is for unit testing only.

Status:

Internal. This API is ICU internal only.

Method Detail

builder

@Deprecated
public static PersonNameFormatter.Builder builder()

Deprecated. This API is for technology preview only.

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

Returns:

A new Builder.

Status:

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

toBuilder

@Deprecated
public PersonNameFormatter.Builder toBuilder()

Deprecated. This API is for technology preview only.

Returns a Builder object whose fields match those used to construct this formatter, allowing a new formatter to be created based on this one.

Returns:

A new Builder that can be used to create a new formatter based on this formatter.

Status:

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

formatToString

@Deprecated
public String formatToString(PersonName name)

Deprecated. This API is for technology preview only.

Formats a name.

Parameters:

name - A PersonName object that supplies individual field values (optionally, with modifiers applied) to the formatter for formatting.

Returns:

The name, formatted according to the locale and other parameters passed to the formatter's constructor.

Status:

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