Класс Locale.Builder

public static final class Locale.Builder
extends Object

Builder используется для построения экземпляров Locale из значений, настроенных с помощью методов-установщиков. В отличие от конструкторов Locale, Builder проверяет, удовлетворяет ли значение, настроенное методом-установщиком, требованиям синтаксиса, определённым классом Locale. Объект Locale, созданный с помощью Builder, имеет корректный формат и может быть преобразован в корректный тег языка IETF BCP 47 без потери информации.

Примечание: Класс Locale не накладывает никаких синтаксических ограничений на вариант, в то время как BCP 47 требует, чтобы каждый подтег варианта состоял из 5–8 буквенно-цифровых символов или одного цифрового символа, за которым следуют 3 буквенно-цифровых символа. Метод setVariant вызывает исключение IllformedLocaleException для варианта, не удовлетворяющего этому ограничению. Если необходимо поддерживать такой вариант, используйте конструктор Locale. Однако помните, что объект Locale созданный таким образом, может потерять информацию о варианте при преобразовании в тег языка BCP 47.

Следующий пример демонстрирует, как создать объект Locale с помощью Builder.

Locale aLocale = new Builder().setLanguage("sr").setScript("Latn").setRegion("RS").build();

Бильдеры могут быть повторно использованы; clear() сбрасывает все поля до их значений по умолчанию.

Конструкторы

Builder

public Builder()

Создаёт пустой Builder. Значение по умолчанию всех полей, расширений и информации для частного использования — пустая строка.

Методы

setLocale

public Locale.Builder setLocale(Locale locale)

Параметры:

locale - локали

Возвращает:

Этот builder.

Выбрасывает:

IllformedLocaleException - если locale имеет какие-либо неправильно сформированные поля.

NullPointerException - если locale равно null.

setLanguageTag

public Locale.Builder setLanguageTag(String languageTag)

Сбрасывает Builder для соответствия предоставленному тегу языка IETF BCP 47. Отбрасывает существующее состояние. Null и пустая строка приводят к сбросу builder, как в clear(). Аннулированные теги (см. Locale.forLanguageTag(java.lang.String)) преобразуются в каноническую форму перед обработкой. В противном случае тег языка должен быть правильно сформирован (см. Locale), в противном случае генерируется исключение (в отличие от Locale.forLanguageTag, которое просто отбрасывает неправильно сформированные и последующие части тега).

Параметры:

languageTag - тег языка

Возвращает:

Этот builder.

Выбрасывает:

IllformedLocaleException - если languageTag неправильно сформирован

См. также:

Locale.forLanguageTag(String)

setLanguage

public Locale.Builder setLanguage(String language)

Параметры:

language - язык

Возвращает:

Этот builder.

Выбрасывает:

IllformedLocaleException - если language неправильно сформирован

setScript

public Locale.Builder setScript(String script)

Параметры:

script - сценарий

Возвращает:

Этот builder.

Выбрасывает:

IllformedLocaleException - если script неправильно сформирован

setRegion

public Locale.Builder setRegion(String region)

Параметры:

region - регион

Возвращает:

Этот builder.

Выбрасывает:

IllformedLocaleException - если region неправильно сформирован

setVariant

public Locale.Builder setVariant(String variant)

Параметры:

variant - вариант

Возвращает:

Этот builder.

Выбрасывает:

IllformedLocaleException - если variant неправильно сформирован

setExtension

public Locale.Builder setExtension(char key,
                                   String value)

Параметры:

key - ключ расширения

value - значение расширения

Возвращает:

Этот builder.

Выбрасывает:

IllformedLocaleException - если key некорректен или value неправильно сформирован

См. также:

setUnicodeLocaleKeyword(String, String)

setUnicodeLocaleKeyword

public Locale.Builder setUnicodeLocaleKeyword(String key,
                                              String type)

Параметры:

key - ключ Unicode локали

type - тип Unicode локали

Возвращает:

Этот builder.

Выбрасывает:

IllformedLocaleException - если key или type неправильно сформированы

NullPointerException - если key равно null

См. также:

setExtension(char, String)

addUnicodeLocaleAttribute

public Locale.Builder addUnicodeLocaleAttribute(String attribute)

Добавляет атрибут локали Юникод, если он ещё не присутствует, в противном случае не оказывает никакого влияния. Атрибут не должен быть null и должен быть правильно сформирован, в противном случае генерируется исключение.

Параметры:

attribute - атрибут

Возвращает:

Этот builder.

Выбрасывает:

NullPointerException - если attribute равно null

IllformedLocaleException - если attribute неправильно сформирован

См. также:

setExtension(char, String)

removeUnicodeLocaleAttribute

public Locale.Builder removeUnicodeLocaleAttribute(String attribute)

Параметры:

attribute - атрибут

Возвращает:

Этот builder.

Выбрасывает:

NullPointerException - если attribute равно null

IllformedLocaleException - если attribute неправильно сформирован

См. также:

setExtension(char, String)

clear

public Locale.Builder clear()

Сбрасывает builder в его начальное пустое состояние.

Возвращает:

Этот builder.

clearExtensions

public Locale.Builder clearExtensions()

Сбрасывает расширения в их начальное пустое состояние. Язык, сценарий, регион и вариант остаются неизменными.

Возвращает:

Этот builder.

См. также:

setExtension(char, String)

build

public Locale build()

Возвращает:

Locale.