public abstract class LocaleNameProvider extends LocaleServiceProvider
Locale
class.Modifier | Constructor | Description |
---|---|---|
protected |
Sole constructor. |
Modifier and Type | Method | Description |
---|---|---|
abstract String |
getDisplayCountry |
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. |
abstract String |
getDisplayLanguage |
Returns a localized name for the given IETF BCP47 language code and the given locale that is appropriate for display to the user. |
String |
getDisplayScript |
Returns a localized name for the given IETF BCP47 script code and the given locale that is appropriate for display to the user. |
String |
getDisplayUnicodeExtensionKey |
Returns a localized name for the given Unicode extension key, and the given locale that is appropriate for display to the user. |
String |
getDisplayUnicodeExtensionType |
Returns a localized name for the given Unicode extension type, and the given locale that is appropriate for display to the user. |
abstract String |
getDisplayVariant |
Returns a localized name for the given variant code and the given locale that is appropriate for display to the user. |
getAvailableLocales, isSupportedLocale
protected LocaleNameProvider()
public abstract String getDisplayLanguage(String languageCode, Locale locale)
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.languageCode
- the language code string in the form of two to eight lower-case letters between 'a' (U+0061) and 'z' (U+007A)locale
- the desired localeNullPointerException
- if languageCode
or locale
is nullIllegalArgumentException
- 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()
.public String getDisplayScript(String scriptCode, Locale locale)
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.scriptCode
- 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
- the desired localeNullPointerException
- if scriptCode
or locale
is nullIllegalArgumentException
- if scriptCode
is not in the form of four title case letters, or locale
isn't one of the locales returned from getAvailableLocales()
.public abstract String getDisplayCountry(String countryCode, Locale locale)
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.countryCode
- 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
- the desired localeNullPointerException
- if countryCode
or locale
is nullIllegalArgumentException
- 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()
.public abstract String getDisplayVariant(String variant, Locale locale)
locale
, this method returns null.variant
- the variant stringlocale
- the desired localeNullPointerException
- if variant
or locale
is nullIllegalArgumentException
- if locale
isn't one of the locales returned from getAvailableLocales()
.public String getDisplayUnicodeExtensionKey(String key, Locale locale)
locale
, this method returns null.null
.key
- the Unicode Extension key, not null.locale
- the desired locale, not null.NullPointerException
- if key
or locale
is nullIllegalArgumentException
- if locale
isn't one of the locales returned from getAvailableLocales()
.public String getDisplayUnicodeExtensionType(String type, String key, Locale locale)
locale
, this method returns null.null
.type
- the Unicode Extension type, not null.key
- the Unicode Extension key for this type
, not null.locale
- the desired locale, not null.NullPointerException
- if key
, type
or locale
is nullIllegalArgumentException
- if locale
isn't one of the locales returned from getAvailableLocales()
.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/spi/LocaleNameProvider.html