Builder

Builder

Builder()

Constructs an empty Builder. The default value of all fields, extensions, and private use information is the empty string.

addUnicodeLocaleAttribute

fun addUnicodeLocaleAttribute(attribute: String): Locale.Builder

Adds a unicode locale attribute, if not already present, otherwise has no effect. The attribute must not be null and must be java.util.Locale# or an exception is thrown.

build

fun build(): Locale

Returns an instance of Locale obtained from the fields set on this builder.

This applies the conversions listed in Locale.forLanguageTag when constructing a Locale. (Legacy tags are handled in setLanguageTag.)

clear

fun clear(): Locale.Builder

Resets the builder to its initial, empty state.

clearExtensions

fun clearExtensions(): Locale.Builder

Resets the extensions to their initial, empty state. Language, script, region and variant are unchanged.

removeUnicodeLocaleAttribute

fun removeUnicodeLocaleAttribute(attribute: String): Locale.Builder

Removes a unicode locale attribute, if present, otherwise has no effect. The attribute must not be null and must be java.util.Locale# or an exception is thrown.

Attribute comparison for removal is case-insensitive.

setExtension

fun setExtension(
    key: Char, 
    value: String?
): Locale.Builder

Sets the extension for the given key. If the value is null or the empty string, the extension is removed. Otherwise, the extension must be java.util.Locale# or an exception is thrown.

Note: The key UNICODE_LOCALE_EXTENSION ('u') is used for the Unicode locale extension. Setting a value for this key replaces any existing Unicode locale key/type pairs with those defined in the extension.

Note: The key PRIVATE_USE_EXTENSION ('x') is used for the private use code. To be well-formed, the value for this key needs only to have subtags of one to eight alphanumeric characters, not two to eight as in the general case.

setLanguage

fun setLanguage(language: String?): Locale.Builder

Sets the language. If language is the empty string or null, the language in this Builder is removed. Otherwise, the language must be java.util.Locale# or an exception is thrown.

The typical language value is a two or three-letter language code as defined in ISO639.

setLanguageTag

fun setLanguageTag(languageTag: String): Locale.Builder

Resets the Builder to match the provided IETF BCP 47 language tag. Discards the existing state. Null and the empty string cause the builder to be reset, like clear. Legacy tags (see java.util.Locale#forLanguageTag) are converted to their canonical form before being processed. Otherwise, the language tag must be well-formed (see Locale) or an exception is thrown (unlike Locale.forLanguageTag, which just discards ill-formed and following portions of the tag).

setLocale

fun setLocale(locale: Locale): Locale.Builder

Resets the Builder to match the provided locale. Existing state is discarded.

All fields of the locale must be well-formed, see Locale.

Locales with any ill-formed fields cause IllformedLocaleException to be thrown, except for the following three cases which are accepted for compatibility reasons:

• Locale("ja", "JP", "JP") is treated as "ja-JP-u-ca-japanese"
• Locale("th", "TH", "TH") is treated as "th-TH-u-nu-thai"
• Locale("no", "NO", "NY") is treated as "nn-NO"

setRegion

fun setRegion(region: String?): Locale.Builder

Sets the region. If region is null or the empty string, the region in this Builder is removed. Otherwise, the region must be java.util.Locale# or an exception is thrown.

The typical region value is a two-letter ISO 3166 code or a three-digit UN M.49 area code.

The country value in the Locale obtained from a Builder is always normalized to upper case.

setScript

fun setScript(script: String?): Locale.Builder

Sets the script. If script is null or the empty string, the script in this Builder is removed. Otherwise, the script must be java.util.Locale# or an exception is thrown.

The typical script value is a four-letter script code as defined by ISO 15924.

setUnicodeLocaleKeyword

fun setUnicodeLocaleKeyword(
    key: String, 
    type: String?
): Locale.Builder

Sets the Unicode locale keyword type for the given key. If the type is null, the Unicode keyword is removed. Otherwise, the key must be non-null and both key and type must be java.util.Locale# or an exception is thrown.

Keys and types are converted to lower case.

Note:Setting the 'u' extension via setExtension replaces all Unicode locale keywords with those defined in the extension.

setVariant

fun setVariant(variant: String?): Locale.Builder

Sets the variant. If variant is null or the empty string, the variant in this Builder is removed. Otherwise, it must consist of one or more java.util.Locale# subtags, or an exception is thrown.

Note: This method checks if variant satisfies the IETF BCP 47 variant subtag's syntax requirements, and normalizes the value to lowercase letters. However, the Locale class does not impose any syntactic restriction on variant, and the variant value in Locale is case sensitive. To set such a variant, use Locale.of(String, String, String).