Класс 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 или код зоны ООН М.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 extension, и заданной локали, подходящее для отображения пользователю.
`String`	`getDisplayUnicodeExtensionType(String type, String key, Locale locale)`	Возвращает локализованное имя для заданного типа расширения Юникода Unicode extension, и заданной локали, подходящее для отображения пользователю.
`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().

См. также:

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

См. также:

getDisplayCountry

public abstract String getDisplayCountry(String countryCode, Locale locale)

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

Параметры:

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

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

Возвращает:

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

Исключение:

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

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

См. также:

getDisplayVariant

public abstract String getDisplayVariant(String variant, Locale locale)

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

Параметры:

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

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

Возвращает:

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

Исключение:

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

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

См. также:

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, 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