Package com.ibm.icu.text
Class PersonNameFormatter
java.lang.Object
com.ibm.icu.text.PersonNameFormatter
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 |
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
A utility class that can be used to construct a PersonNameFormatter.static enum
An enum indicating the desired display order for a formatted name.static enum
Specifies the intended formality of the formatted name.static enum
Specifies the desired length of the formatted name.static enum
Specifies the intended usage of the formatted name. -
Constructor Summary
ConstructorsConstructorDescriptionPersonNameFormatter
(Locale locale, String[] patterns) Deprecated.This API is for unit testing only. -
Method Summary
Modifier and TypeMethodDescriptionstatic PersonNameFormatter.Builder
builder()
Returns a Builder object that can be used to construct a new PersonNameFormatter.formatToString
(PersonName name) Formats a name.Returns a Builder object whose fields match those used to construct this formatter, allowing a new formatter to be created based on this one.toString()
Deprecated.This API is for debugging only.
-
Constructor Details
-
PersonNameFormatter
Deprecated.This API is for unit testing only.
-
-
Method Details
-
builder
Returns a Builder object that can be used to construct a new PersonNameFormatter.- Returns:
- A new Builder.
-
toBuilder
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.
-
formatToString
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.
-
toString
Deprecated.This API is for debugging only.
-