com.force.i18n

Class LocaleNameFormatter

java.lang.Object

com.force.i18n.LocaleNameFormatter

public class LocaleNameFormatter
extends Object

Performs locale-sensitive formatting of name fields.

Author:

jared.pearson

Constructor Summary

Constructors

Constructor and Description
LocaleNameFormatter() Creates a new formatter with the locale information from DefaultLocaleAttributesUtil.
LocaleNameFormatter(Iterable<? extends LocaleInfo> localeInfos) Deprecated. Use LocaleNameFormatter(LocaleAttributesUtil) instead
LocaleNameFormatter(LocaleAttributesUtil localeConfig) Creates a new formatter with the given locale information.

Method Summary

Modifier and Type	Method and Description
String	format(Locale locale, String firstName, String lastName) Performs locale-sensitive formatting of a name using all fields (if they apply in the locale).
String	format(Locale locale, String salutation, String firstName, String lastName) Performs locale-sensitive formatting of a name using all fields (if they apply in the locale).
String	format(Locale locale, String salutation, String firstName, String lastName, boolean casual) Performs locale-sensitive formatting of a name using all fields (if they apply in the locale).
String	format(Locale locale, String salutation, String firstName, String lastName, String middleName, String informalName, String suffix) Performs locale-sensitive formatting of a name using all fields (if they apply in the locale).
String	format(Locale locale, String salutation, String firstName, String lastName, String middleName, String informalName, String suffix, boolean casual) Performs locale-sensitive formatting of a name using all fields (if they apply in the locale).
boolean	isFormalLocale(Locale locale) Deprecated. Use LocaleAttributesUtil.isFormalLocale(Locale) instead
boolean	useEasternNameOrder(Locale locale) Deprecated. Use LocaleAttributesUtil.useEasternNameOrder(Locale) instead

Methods inherited from class java.lang.Object

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

Constructor Detail

LocaleNameFormatter

public LocaleNameFormatter()

Creates a new formatter with the locale information from DefaultLocaleAttributesUtil.

LocaleNameFormatter

public LocaleNameFormatter(LocaleAttributesUtil localeConfig)

Creates a new formatter with the given locale information.

Parameters:

localeConfig - the extra information associated to a locale

LocaleNameFormatter

@Deprecated
public LocaleNameFormatter(Iterable<? extends LocaleInfo> localeInfos)

Deprecated. Use LocaleNameFormatter(LocaleAttributesUtil) instead

Creates a new formatter with the given locale information.

Parameters:

localeInfos - the collection of extra information associated to a locale

Method Detail

isFormalLocale

@Deprecated
public boolean isFormalLocale(Locale locale)

Deprecated. Use LocaleAttributesUtil.isFormalLocale(Locale) instead

Returns:

true when the specified locale should be considered "formal", in that you should always use the full name when addressing a user.

useEasternNameOrder

@Deprecated
public boolean useEasternNameOrder(Locale locale)

Deprecated. Use LocaleAttributesUtil.useEasternNameOrder(Locale) instead

Returns:

true when the specified locale uses an eastern name order.

format

public String format(Locale locale,
                     String firstName,
                     String lastName)

Performs locale-sensitive formatting of a name using all fields (if they apply in the locale).

Might return a String with a trailing space -- deal with it.

Parameters:

locale - the locale that the name is displayed in

firstName - the first name of the person

lastName - the last name of the person

Returns:

String representing the locale-formatted name

format

public String format(Locale locale,
                     String salutation,
                     String firstName,
                     String lastName)

Performs locale-sensitive formatting of a name using all fields (if they apply in the locale).

Might return a String with a trailing space -- deal with it.

Parameters:

locale - the locale that the name is displayed in

salutation - the salutation of the person or null if not specified

firstName - the first name of the person

lastName - the last name of the person

Returns:

String representing the locale-formatted name

format

public String format(Locale locale,
                     String salutation,
                     String firstName,
                     String lastName,
                     boolean casual)

Performs locale-sensitive formatting of a name using all fields (if they apply in the locale).

Might return a String with a trailing space -- deal with it.

Parameters:

locale - the locale that the name is displayed in

salutation - the salutation of the person or null if not specified

firstName - the first name of the person

lastName - the last name of the person

casual - if true, use first name only, if the locale allows it

Returns:

String representing the locale-formatted name

format

public String format(Locale locale,
                     String salutation,
                     String firstName,
                     String lastName,
                     String middleName,
                     String informalName,
                     String suffix)

Performs locale-sensitive formatting of a name using all fields (if they apply in the locale).

Might return a String with a trailing space -- deal with it.

Parameters:

locale - the locale that the name is displayed in

salutation - the salutation of the person or null if not specified

firstName - the first name of the person

lastName - the last name of the person

middleName - the middle name of the person or null if not specified

informalName - the informal name of the person or null if not specified

suffix - the suffix or null if not specified

Returns:

String representing the locale-formatted name

format

public String format(Locale locale,
                     String salutation,
                     String firstName,
                     String lastName,
                     String middleName,
                     String informalName,
                     String suffix,
                     boolean casual)

Performs locale-sensitive formatting of a name using all fields (if they apply in the locale).

Might return a String with a trailing space -- deal with it.

Parameters:

locale - the locale that the name is displayed in

salutation - the salutation of the person or null if not specified

firstName - the first name of the person

lastName - the last name of the person

middleName - the middle name of the person or null if not specified

informalName - the informal name of the person or null if not specified

suffix - the suffix or null if not specified

casual - if true, use first name only, if the locale allows it

Returns:

String representing the locale-formatted name