OpenJDK 1.23 · java.util.spi.LocaleNameProvider · APIdia, the JavaDoc alternative

Access	Constructor and Description
protected	LocaleNameProvider() Sole constructor.

Method Summary

Modifier and Type	Method and Description
public abstract String	Returns: the name of the given country code for the specified locale, or null if it's not available. getDisplayCountry(String the country(region) code string in the form of two upper-case letters between 'A' (U+0041) and 'Z' (U+005A) or the UN M.49 area code in the form of three digit letters between '0' (U+0030) and '9' (U+0039). countryCode, Locale the desired locale locale) Returns a localized name for the given IETF BCP47 region code (either ISO 3166 country code or UN M.49 area codes) and the given locale that is appropriate for display to the user.
public abstract String	Returns: the name of the given language code for the specified locale, or null if it's not available. getDisplayLanguage(String the language code string in the form of two to eight lower-case letters between 'a' (U+0061) and 'z' (U+007A) languageCode, Locale the desired locale locale) Returns a localized name for the given IETF BCP47 language code and the given locale that is appropriate for display to the user.
public String	Returns: the name of the given script code for the specified locale, or null if it's not available. getDisplayScript(String the four letter script code string in the form of title-case letters (the first letter is upper-case character between 'A' (U+0041) and 'Z' (U+005A) followed by three lower-case character between 'a' (U+0061) and 'z' (U+007A)). scriptCode, Locale the desired locale locale) Returns a localized name for the given IETF BCP47 script code and the given locale that is appropriate for display to the user.
public String	Returns: the name of the given key string for the specified locale, or null if it's not available. getDisplayUnicodeExtensionKey(String the Unicode Extension key, not null. key, Locale the desired locale, not null. locale) Returns a localized name for the given Unicode extension key, and the given locale that is appropriate for display to the user.
public String	Returns: the name of the given type string for the specified locale, or null if it's not available. getDisplayUnicodeExtensionType(String the Unicode Extension type, not null. type, String the Unicode Extension key for this `type`, not null. key, Locale the desired locale, not null. locale) Returns a localized name for the given Unicode extension type, and the given locale that is appropriate for display to the user.
public abstract String	Returns: the name of the given variant string for the specified locale, or null if it's not available. getDisplayVariant(String the variant string variant, Locale the desired locale locale) Returns a localized name for the given variant code and the given locale that is appropriate for display to the user.

Inherited from java.util.spi.LocaleServiceProvider:: getAvailableLocales isSupportedLocale

LocaleNameProvider	back to summary
protected LocaleNameProvider() Sole constructor. (For invocation by subclass constructors, typically implicit.)

Method Detail

getDisplayCountry back to summary

getDisplayCountry	back to summary
public abstract String getDisplayCountry(String countryCode, Locale locale) Returns a localized name for the given IETF BCP47 region code (either ISO 3166 country code or UN M.49 area codes) 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. Parameters countryCode:String the country(region) code string in the form of two upper-case letters between 'A' (U+0041) and 'Z' (U+005A) or the UN M.49 area code in the form of three digit letters between '0' (U+0030) and '9' (U+0039). locale:Locale the desired locale Returns:String the name of the given country code for the specified locale, or null if it's not available. Exceptions NullPointerException: if `countryCode` or `locale` is null IllegalArgumentException: if `countryCode` is not in the form of two upper-case letters or three digit letters, or `locale` isn't one of the locales returned from `getAvailableLocales()`. See Also `java.util.Locale#getDisplayCountry(java.util.Locale)`

public abstract String getDisplayCountry(String countryCode, Locale locale)

Returns a localized name for the given IETF BCP47 region code (either ISO 3166 country code or UN M.49 area codes) 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.

Parameters

countryCode:String: the country(region) code string in the form of two upper-case letters between 'A' (U+0041) and 'Z' (U+005A) or the UN M.49 area code in the form of three digit letters between '0' (U+0030) and '9' (U+0039).
locale:Locale: the desired locale

Returns:String

the name of the given country code for the specified locale, or null if it's not available.

Exceptions

NullPointerException:: if countryCode or locale is null
IllegalArgumentException:: if countryCode is not in the form of two upper-case letters or three digit letters, or locale isn't one of the locales returned from getAvailableLocales().

getDisplayLanguage back to summary

getDisplayLanguage	back to summary
public abstract String getDisplayLanguage(String languageCode, Locale locale) Returns a localized name for the given IETF BCP47 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. Parameters languageCode:String the language code string in the form of two to eight lower-case letters between 'a' (U+0061) and 'z' (U+007A) locale:Locale the desired locale Returns:String the name of the given language code for the specified locale, or null if it's not available. Exceptions NullPointerException: if `languageCode` or `locale` is null IllegalArgumentException: if `languageCode` is not in the form of two or three lower-case letters, or `locale` isn't one of the locales returned from `getAvailableLocales()`. See Also `java.util.Locale#getDisplayLanguage(java.util.Locale)`

public abstract String getDisplayLanguage(String languageCode, Locale locale)

Returns a localized name for the given IETF BCP47 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.

Parameters

languageCode:String: the language code string in the form of two to eight lower-case letters between 'a' (U+0061) and 'z' (U+007A)
locale:Locale: the desired locale

Returns:String

the name of the given language code for the specified locale, or null if it's not available.

Exceptions

NullPointerException:: if languageCode or locale is null
IllegalArgumentException:: if languageCode is not in the form of two or three lower-case letters, or locale isn't one of the locales returned from getAvailableLocales().

getDisplayScript back to summary

getDisplayScript	back to summary
public String getDisplayScript(String scriptCode, Locale locale) Returns a localized name for the given IETF BCP47 script code and the given locale that is appropriate for display to the user. For example, if `scriptCode` is "Latn" and `locale` is en_US, getDisplayScript() will return "Latin"; if `scriptCode` is "Cyrl" and `locale` is fr_FR, getDisplayScript() will return "cyrillique". If the name returned cannot be localized according to `locale`, (say, the provider does not have a Japanese name for Cyrillic), this method returns null. The default implementation returns null. Parameters scriptCode:String the four letter script code string in the form of title-case letters (the first letter is upper-case character between 'A' (U+0041) and 'Z' (U+005A) followed by three lower-case character between 'a' (U+0061) and 'z' (U+007A)). locale:Locale the desired locale Returns:String the name of the given script code for the specified locale, or null if it's not available. Exceptions NullPointerException: if `scriptCode` or `locale` is null IllegalArgumentException: if `scriptCode` is not in the form of four title case letters, or `locale` isn't one of the locales returned from `getAvailableLocales()`. Since 1.7 See Also `java.util.Locale#getDisplayScript(java.util.Locale)`

public String getDisplayScript(String scriptCode, Locale locale)

Returns a localized name for the given IETF BCP47 script code and the given locale that is appropriate for display to the user. For example, if scriptCode is "Latn" and locale is en_US, getDisplayScript() will return "Latin"; if scriptCode is "Cyrl" and locale is fr_FR, getDisplayScript() will return "cyrillique". If the name returned cannot be localized according to locale, (say, the provider does not have a Japanese name for Cyrillic), this method returns null. The default implementation returns null.

Parameters

scriptCode:String: the four letter script code string in the form of title-case letters (the first letter is upper-case character between 'A' (U+0041) and 'Z' (U+005A) followed by three lower-case character between 'a' (U+0061) and 'z' (U+007A)).
locale:Locale: the desired locale

Returns:String

the name of the given script code for the specified locale, or null if it's not available.

Exceptions

NullPointerException:: if scriptCode or locale is null
IllegalArgumentException:: if scriptCode is not in the form of four title case letters, or locale isn't one of the locales returned from getAvailableLocales().

Since

1.7

getDisplayUnicodeExtensionKey back to summary

getDisplayUnicodeExtensionKey	back to summary
public String getDisplayUnicodeExtensionKey(String key, Locale locale) Returns a localized name for the given Unicode extension key, 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. Implementation Specification the default implementation returns `null`. Parameters key:String the Unicode Extension key, not null. locale:Locale the desired locale, not null. Returns:String the name of the given key string for the specified locale, or null if it's not available. Exceptions NullPointerException: if `key` or `locale` is null IllegalArgumentException: if `locale` isn't one of the locales returned from `getAvailableLocales()`. Since 10

public String getDisplayUnicodeExtensionKey(String key, Locale locale)

Returns a localized name for the given Unicode extension key, 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.

Implementation Specification

the default implementation returns null.

Parameters

key:String: the Unicode Extension key, not null.
locale:Locale: the desired locale, not null.

Returns:String

the name of the given key string for the specified locale, or null if it's not available.

Exceptions

NullPointerException:: if key or locale is null
IllegalArgumentException:: if locale isn't one of the locales returned from getAvailableLocales().

Since

getDisplayUnicodeExtensionType back to summary

getDisplayUnicodeExtensionType	back to summary
public String getDisplayUnicodeExtensionType(String type, String key, Locale locale) Returns a localized name for the given Unicode extension type, 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. Implementation Specification the default implementation returns `null`. Parameters type:String the Unicode Extension type, not null. key:String the Unicode Extension key for this `type`, not null. locale:Locale the desired locale, not null. Returns:String the name of the given type string for the specified locale, or null if it's not available. Exceptions NullPointerException: if `key`, `type` or `locale` is null IllegalArgumentException: if `locale` isn't one of the locales returned from `getAvailableLocales()`. Since 10

public String getDisplayUnicodeExtensionType(String type, String key, Locale locale)

Returns a localized name for the given Unicode extension type, 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.

Implementation Specification

the default implementation returns null.

Parameters

type:String: the Unicode Extension type, not null.
key:String: the Unicode Extension key for this type, not null.
locale:Locale: the desired locale, not null.

Returns:String

the name of the given type string for the specified locale, or null if it's not available.

Exceptions

NullPointerException:: if key, type or locale is null
IllegalArgumentException:: if locale isn't one of the locales returned from getAvailableLocales().

Since

getDisplayVariant back to summary

getDisplayVariant	back to summary
public abstract String getDisplayVariant(String variant, 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. Parameters variant:String the variant string locale:Locale the desired locale Returns:String the name of the given variant string for the specified locale, or null if it's not available. Exceptions NullPointerException: if `variant` or `locale` is null IllegalArgumentException: if `locale` isn't one of the locales returned from `getAvailableLocales()`. See Also `java.util.Locale#getDisplayVariant(java.util.Locale)`

public abstract String getDisplayVariant(String variant, 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.

Parameters

variant:String: the variant string
locale:Locale: the desired locale

Returns:String

the name of the given variant string for the specified locale, or null if it's not available.

Exceptions

NullPointerException:: if variant or locale is null
IllegalArgumentException:: if locale isn't one of the locales returned from getAvailableLocales().

public abstract Class LocaleNameProvider

Constructor Summary

Method Summary

Constructor Detail

Method Detail