Класс LocaleNameProvider

java.lang.Object

java.util.spi.LocaleServiceProvider

java.util.spi.LocaleNameProvider

public abstract class LocaleNameProvider extends LocaleServiceProvider

Абстрактный класс для поставщиков сервисов, предоставляющих локализованные имена для класса Locale.

Since:: 1.6

Краткое описание конструкторов

LocaleNameProvider()

Модификатор	Конструктор	Описание
`protected`	Единственный конструктор.

Краткое описание методов

Модификатор и тип	Метод	Описание
`abstract String`	`getDisplayCountry(String countryCode, Locale locale)`	Возвращает локализованное имя для данного кода региона IETF BCP47 (либо код страны ISO 3166, либо код зоны UN M.49) и данного локали, подходящее для отображения пользователю.
`abstract String`	`getDisplayLanguage(String languageCode, Locale locale)`	Возвращает локализованное имя для данного кода языка IETF BCP47 и данного локали, подходящее для отображения пользователю.
`String`	`getDisplayScript(String scriptCode, Locale locale)`	Возвращает локализованное имя для данного кода скрипта IETF BCP47 и данного локали, подходящее для отображения пользователю.
`String`	`getDisplayUnicodeExtensionKey(String key, Locale locale)`	Возвращает локализованное имя для данного ключа расширения Unicode, и данного локали, подходящее для отображения пользователю.
`String`	`getDisplayUnicodeExtensionType(String type, String key, Locale locale)`	Возвращает локализованное имя для данного типа расширения Unicode, и данного локали, подходящее для отображения пользователю.
`abstract String`	`getDisplayVariant(String variant, Locale locale)`	Возвращает локализованное имя для данного кода варианта и данного локали, подходящее для отображения пользователю.

Методы, объявленные в классе java.util.spi.LocaleServiceProvider

getAvailableLocales, isSupportedLocale

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание конструкторов

LocaleNameProvider

protected LocaleNameProvider()

Единственный конструктор. (Для вызова конструкторами подклассов, обычно неявным).

Подробное описание методов

getDisplayLanguage

public abstract String getDisplayLanguage(String languageCode, Locale locale)

Возвращает локализованное имя для данного кода языка IETF BCP47 и данного региона, подходящее для отображения пользователю. Например, если languageCode — "fr", а locale — en_US, getDisplayLanguage() вернёт "Французский"; если languageCode — "en", а locale — fr_FR, getDisplayLanguage() вернёт "английский". Если возвращаемое имя не может быть локализовано в соответствии с locale, (например, у поставщика нет японского названия для хорватского языка), этот метод возвращает null.

Параметры:

languageCode - строка кода языка в формате от двух до восьми строчных букв от 'a' (U+0061) до 'z' (U+007A)

locale - желаемый регион

Возвращает:

название данного кода языка для указанного региона или null, если он недоступен.

Исключение:

NullPointerException - если languageCode или locale равны null

IllegalArgumentException - если languageCode не имеет формы из двух или трёх строчных букв, или locale не является одним из регионов, возвращённых из getAvailableLocales().

См. также:

Locale.getDisplayLanguage(java.util.Locale)

getDisplayScript

public String getDisplayScript(String scriptCode, Locale locale)

Возвращает локализованное имя для данного кода скрипта IETF BCP47 и данного региона, подходящее для отображения пользователю. Например, если scriptCode — "Latn", а locale — en_US, getDisplayScript() вернёт "Латинский"; если scriptCode — "Cyrl", а locale — fr_FR, getDisplayScript() вернёт "кириллический". Если возвращаемое имя не может быть локализовано в соответствии с locale, (например, у поставщика нет японского названия для кириллицы), этот метод возвращает null. По умолчанию возвращается null.

Параметры:

scriptCode - строка кода скрипта из четырёх заглавных букв (первая буква заглавная от 'A' (U+0041) до 'Z' (U+005A), а последующие три строчные от 'a' (U+0061) до 'z' (U+007A)).

locale - желаемый регион

Возвращает:

название данного кода скрипта для указанного региона или null, если он недоступен.

Исключение:

NullPointerException - если scriptCode или locale равны null

IllegalArgumentException - если scriptCode не имеет формы из четырёх заглавных букв, или locale не является одним из регионов, возвращённых из getAvailableLocales().

С:

1.7

См. также:

Locale.getDisplayScript(java.util.Locale)

getDisplayCountry

public abstract String getDisplayCountry(String countryCode, Locale locale)

Возвращает локализованное имя для данного кода региона IETF BCP47 (код страны ISO 3166 или код региона ООН M.49) и данного региона, подходящее для отображения пользователю. Например, если countryCode — "FR", а locale — en_US, getDisplayCountry() вернёт "Франция"; если countryCode — "US", а locale — fr_FR, getDisplayCountry() вернёт "Соединённые Штаты". Если возвращаемое имя не может быть локализовано в соответствии с locale, (например, у поставщика нет японского названия для Хорватии), этот метод возвращает null.

Параметры:

countryCode - строка кода страны(региона) в формате из двух заглавных букв от 'A' (U+0041) до 'Z' (U+005A) или код региона ООН M.49 в формате из трёх цифр от '0' (U+0030) до '9' (U+0039).

locale - желаемый регион

Возвращает:

название данного кода страны для указанного региона или null, если он недоступен.

Исключение:

NullPointerException - если countryCode или locale равны null

IllegalArgumentException - если countryCode не имеет формы из двух заглавных букв или трёх цифр, или locale не является одним из регионов, возвращённых из getAvailableLocales().

См. также:

Locale.getDisplayCountry(java.util.Locale)

getDisplayVariant

public abstract String getDisplayVariant(String variant, Locale locale)

Возвращает локализованное имя для данного кода варианта и данного региона, подходящее для отображения пользователю. Если возвращаемое имя не может быть локализовано в соответствии с locale, этот метод возвращает null.

Параметры:

variant - строка кода варианта

locale - желаемый регион

Возвращает:

название данного кода варианта для указанного региона или null, если он недоступен.

Исключение:

NullPointerException - если variant или locale равны null

IllegalArgumentException - если locale не является одним из регионов, возвращённых из getAvailableLocales().

См. также:

Locale.getDisplayVariant(java.util.Locale)

getDisplayUnicodeExtensionKey

public String getDisplayUnicodeExtensionKey(String key, Locale locale)

Возвращает локализованное имя для данного ключа расширения Unicode и данного региона, подходящее для отображения пользователю. Если возвращаемое имя не может быть локализовано в соответствии с locale, этот метод возвращает null.

Требования к реализации:: по умолчанию возвращает null.
Параметры:: key - ключ расширения Unicode, не null.; locale - желаемый регион, не null.
Возвращает:: название данного ключа для указанного региона или null, если он недоступен.
Исключение:: NullPointerException - если key или locale равны null; IllegalArgumentException - если locale не является одним из регионов, возвращённых из getAvailableLocales().
С:: 10

getDisplayUnicodeExtensionType

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

Возвращает локализованное имя для данного типа расширения Unicode и данного региона, подходящее для отображения пользователю. Если возвращаемое имя не может быть локализовано в соответствии с locale, этот метод возвращает null.

Требования к реализации:: по умолчанию возвращает null.
Параметры:: type - тип расширения Unicode, не null.; key - ключ расширения Unicode для данного type, не null.; locale - желаемый регион, не null.
Возвращает:: название данного типа для указанного региона или null, если он недоступен.
Исключение:: NullPointerException - если key, type или locale равны null; IllegalArgumentException - если locale не является одним из регионов, возвращённых из getAvailableLocales().
С:: 10

© 1993, 2021, 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/17/docs/api/java.base/java/util/spi/LocaleNameProvider.html