org.softsmithy.lib.text

Enum LocaleLocalizer

java.lang.Object

java.lang.Enum<LocaleLocalizer>

org.softsmithy.lib.text.LocaleLocalizer

All Implemented Interfaces:

Serializable, Comparable<LocaleLocalizer>, Localizer<Locale>

public enum LocaleLocalizer
extends Enum<LocaleLocalizer>
implements Localizer<Locale>

This class specifies, which display String should be used with Locales (see strategy pattern).

Note: Is this really a ennum? Better way??

Author:

puce

Enum Constant Summary

Enum Constants

Enum Constant and Description
COUNTRY Selects the Locale.getDisplayCountry(java.util.Locale) method.
LANGUAGE Selects the Locale.getDisplayLanguage(java.util.Locale) method.
NAME Selects the Locale.getDisplayName(java.util.Locale) method.
VARIANT Selects the Locale.getDisplayVariant(java.util.Locale) method.

Method Summary

Modifier and Type	Method and Description
abstract String	getDisplayString(Locale locale, Locale inLocale) Returns a string that is appropriate to display to the user.
static LocaleLocalizer	valueOf(String name) Returns the enum constant of this type with the specified name.
static LocaleLocalizer[]	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

NAME

public static final LocaleLocalizer NAME

Selects the Locale.getDisplayName(java.util.Locale) method.

LANGUAGE

public static final LocaleLocalizer LANGUAGE

Selects the Locale.getDisplayLanguage(java.util.Locale) method.

COUNTRY

public static final LocaleLocalizer COUNTRY

Selects the Locale.getDisplayCountry(java.util.Locale) method.

VARIANT

public static final LocaleLocalizer VARIANT

Selects the Locale.getDisplayVariant(java.util.Locale) method.

Method Detail

values

public static LocaleLocalizer[] 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 (LocaleLocalizer c : LocaleLocalizer.values())
    System.out.println(c);

Returns:

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

valueOf

public static LocaleLocalizer 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

getDisplayString

public abstract String getDisplayString(Locale locale,
                                        Locale inLocale)

Returns a string that is appropriate to display to the user. If possible, the string returned will be localized according to inLocale.

Specified by:

getDisplayString in interface Localizer<Locale>

Parameters:

locale - the object to display

inLocale - the string returned will be localized according to this value, if possible

Returns:

a string that is appropriate to display to the user.