java.util.spi

Class LocaleNameProvider

public abstract class LocaleNameProvider extends LocaleServiceProvider

A {@link LocaleNameProvider} provides localized versions of the names that represent a particular locale. Note that a null value may be returned, which should be treated as a lack of support for the specified {@link Locale}.

Since: 1.6

Constructor Summary
protected	LocaleNameProvider() Constructs a new {@link LocaleNameProvider}.

Method Summary
abstract String	getDisplayCountry(String countryCode, Locale locale) Returns the localized name for the specified ISO 3166 country in the supplied {@link java.util.Locale}.
abstract String	getDisplayLanguage(String langCode, Locale locale) Returns the localized name for the specified ISO 639 language in the supplied {@link java.util.Locale}.
abstract String	getDisplayVariant(String variant, Locale locale) Returns the localized name for the specified variant in the supplied {@link java.util.Locale}.

Constructor Detail

LocaleNameProvider

protected LocaleNameProvider()

Constructs a new {@link LocaleNameProvider}. Provided for implicit invocation by subclasses.

Method Detail

getDisplayCountry

public abstract String getDisplayCountry(String countryCode, Locale locale)

Returns the localized name for the specified ISO 3166 country in the supplied {@link java.util.Locale}. For example, if the country code is "DE", this method will return "Germany" for {@link Locale.ENGLISH} but "Deutschland" for {@link Locale.GERMANY}. If the name of the country in the given locale is not supported, null is returned.

Parameters: countryCode the ISO 3166 country code, consisting of two uppercase letters from 'A' to 'Z' locale the locale to express the country in.

Returns: the country name, or null if one is not available.

Throws: NullPointerException if the locale is null. IllegalArgumentException if the country code is not in the correct format or the locale is not one returned by {@link getAvailableLocales()}

getDisplayLanguage

public abstract String getDisplayLanguage(String langCode, Locale locale)

Returns the localized name for the specified ISO 639 language in the supplied {@link java.util.Locale}. For example, if the language code is "de", this method will return "German" for {@link Locale.ENGLISH} but "Deutsch" for {@link Locale.GERMANY}. If the name of the language in the given locale is not supported, null is returned.

Parameters: langCode the ISO 639 language code, consisting of two lowercase letters from 'a' to 'z' locale the locale to express the language in.

Returns: the country name, or null if one is not available.

Throws: NullPointerException if the locale is null. IllegalArgumentException if the language code is not in the correct format or the locale is not one returned by {@link getAvailableLocales()}

getDisplayVariant

public abstract String getDisplayVariant(String variant, Locale locale)

Returns the localized name for the specified variant in the supplied {@link java.util.Locale}. If the name of the variant in the given locale is not supported, null is returned.

Parameters: variant the variant. locale the locale to express the variant in.

Returns: the localized variant, or null if one is not available.

Throws: NullPointerException if the locale is null. IllegalArgumentException if the locale is not one returned by {@link getAvailableLocales()}