FileDocCategorySizeDatePackage
LocaleNameProvider.javaAPI DocJava SE 6 API4558Tue Jun 10 00:26:00 BST 2008java.util.spi

LocaleNameProvider

public abstract class LocaleNameProvider extends LocaleServiceProvider
An abstract class for service providers that provide localized names for the {@link java.util.Locale Locale} class.
since
1.6
version
@(#)LocaleNameProvider.java 1.2 05/11/17

Fields Summary
Constructors Summary
protected LocaleNameProvider()
Sole constructor. (For invocation by subclass constructors, typically implicit.)

    
Methods Summary
public abstract java.lang.StringgetDisplayCountry(java.lang.String countryCode, java.util.Locale locale)
Returns a localized name for the given ISO 3166 country code and the given locale that is appropriate for display to the user. For example, if countryCode is "FR" and locale is en_US, getDisplayCountry() will return "France"; if countryCode is "US" and locale is fr_FR, getDisplayCountry() will return "Etats-Unis". If the name returned cannot be localized according to locale, (say, the provider does not have a Japanese name for Croatia), this method returns null.

param
countryCode the ISO 3166 country code string in the form of two upper-case letters between 'A' (U+0041) and 'Z' (U+005A)
param
locale the desired locale
return
the name of the given country code for the specified locale, or null if it's not available.
exception
NullPointerException if countryCode or locale is null
exception
IllegalArgumentException if countryCode is not in the form of two upper-case letters, or locale isn't one of the locales returned from {@link java.util.spi.LocaleServiceProvider#getAvailableLocales() getAvailableLocales()}.
see
java.util.Locale#getDisplayCountry(java.util.Locale)

public abstract java.lang.StringgetDisplayLanguage(java.lang.String languageCode, java.util.Locale locale)
Returns a localized name for the given ISO 639 language code and the given locale that is appropriate for display to the user. For example, if languageCode is "fr" and locale is en_US, getDisplayLanguage() will return "French"; if languageCode is "en" and locale is fr_FR, getDisplayLanguage() will return "anglais". If the name returned cannot be localized according to locale, (say, the provider does not have a Japanese name for Croatian), this method returns null.

param
languageCode the ISO 639 language code string in the form of two lower-case letters between 'a' (U+0061) and 'z' (U+007A)
param
locale the desired locale
return
the name of the given language code for the specified locale, or null if it's not available.
exception
NullPointerException if languageCode or locale is null
exception
IllegalArgumentException if languageCode is not in the form of two lower-case letters, or locale isn't one of the locales returned from {@link java.util.spi.LocaleServiceProvider#getAvailableLocales() getAvailableLocales()}.
see
java.util.Locale#getDisplayLanguage(java.util.Locale)

public abstract java.lang.StringgetDisplayVariant(java.lang.String variant, java.util.Locale locale)
Returns a localized name for the given variant code and the given locale that is appropriate for display to the user. If the name returned cannot be localized according to locale, this method returns null.

param
variant the variant string
param
locale the desired locale
return
the name of the given variant string for the specified locale, or null if it's not available.
exception
NullPointerException if variant or locale is null
exception
IllegalArgumentException if locale isn't one of the locales returned from {@link java.util.spi.LocaleServiceProvider#getAvailableLocales() getAvailableLocales()}.
see
java.util.Locale#getDisplayVariant(java.util.Locale)