public static final class ULocale.Builder
extends java.lang.Object
Builder is used to build instances of ULocale
from values configured by the setters. Unlike the ULocale
constructors, the Builder checks if a value configured by a
setter satisfies the syntax requirements defined by the ULocale
class. A ULocale object created by a Builder is
well-formed and can be transformed to a well-formed IETF BCP 47 language tag
without losing information.
Note: The ULocale class does not provide any
syntactic restrictions on variant, while BCP 47 requires each variant
subtag to be 5 to 8 alphanumerics or a single numeric followed by 3
alphanumerics. The method setVariant throws
IllformedLocaleException for a variant that does not satisfy
this restriction. If it is necessary to support such a variant, use a
ULocale constructor. However, keep in mind that a ULocale
object created this way might lose the variant information when
transformed to a BCP 47 language tag.
The following example shows how to create a Locale object
with the Builder.
ULocale aLocale = new Builder().setLanguage("sr").setScript("Latn").setRegion("RS").build();
Builders can be reused; clear() resets all
fields to their default values.
ULocale.toLanguageTag()| Constructor and Description |
|---|
Builder()
Constructs an empty Builder.
|
| Modifier and Type | Method and Description |
|---|---|
ULocale.Builder |
addUnicodeLocaleAttribute(java.lang.String attribute)
Adds a unicode locale attribute, if not already present, otherwise
has no effect.
|
ULocale |
build()
Returns an instance of
ULocale created from the fields set
on this builder. |
ULocale.Builder |
clear()
Resets the builder to its initial, empty state.
|
ULocale.Builder |
clearExtensions()
Resets the extensions to their initial, empty state.
|
ULocale.Builder |
removeUnicodeLocaleAttribute(java.lang.String attribute)
Removes a unicode locale attribute, if present, otherwise has no
effect.
|
ULocale.Builder |
setExtension(char key,
java.lang.String value)
Sets the extension for the given key.
|
ULocale.Builder |
setLanguage(java.lang.String language)
Sets the language.
|
ULocale.Builder |
setLanguageTag(java.lang.String languageTag)
Resets the Builder to match the provided IETF BCP 47
language tag.
|
ULocale.Builder |
setLocale(ULocale locale)
Resets the
Builder to match the provided
locale. |
ULocale.Builder |
setRegion(java.lang.String region)
Sets the region.
|
ULocale.Builder |
setScript(java.lang.String script)
Sets the script.
|
ULocale.Builder |
setUnicodeLocaleKeyword(java.lang.String key,
java.lang.String type)
Sets the Unicode locale keyword type for the given key.
|
ULocale.Builder |
setVariant(java.lang.String variant)
Sets the variant.
|
public Builder()
public ULocale.Builder setLocale(ULocale locale)
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.
locale - the localeIllformedLocaleException - if locale has
any ill-formed fields.java.lang.NullPointerException - if locale is null.public ULocale.Builder setLanguageTag(java.lang.String languageTag)
clear(). Grandfathered tags (see ULocale.forLanguageTag(java.lang.String)) are converted to their canonical
form before being processed. Otherwise, the language tag
must be well-formed (see ULocale) or an exception is
thrown (unlike ULocale.forLanguageTag, which
just discards ill-formed and following portions of the
tag).languageTag - the language tagIllformedLocaleException - if languageTag is ill-formedULocale.forLanguageTag(String)public ULocale.Builder setLanguage(java.lang.String language)
language is the empty string or
null, the language in this Builder is removed. Otherwise,
the language must be well-formed
or an exception is thrown.
The typical language value is a two or three-letter language code as defined in ISO639.
language - the languageIllformedLocaleException - if language is ill-formedpublic ULocale.Builder setScript(java.lang.String script)
script is null or the empty string,
the script in this Builder is removed.
Otherwise, the script must be well-formed or an exception is thrown.
The typical script value is a four-letter script code as defined by ISO 15924.
script - the scriptIllformedLocaleException - if script is ill-formedpublic ULocale.Builder setRegion(java.lang.String region)
Builder is removed. Otherwise,
the region must be well-formed 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 created by the
Builder is always normalized to upper case.
region - the regionIllformedLocaleException - if region is ill-formedpublic ULocale.Builder setVariant(java.lang.String variant)
Builder is removed. Otherwise, it
must consist of one or more well-formed 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 ULocale class does not impose any syntactic
restriction on variant. To set such a variant,
use a ULocale constructor.
variant - the variantIllformedLocaleException - if variant is ill-formedpublic ULocale.Builder setExtension(char key, java.lang.String value)
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.
key - the extension keyvalue - the extension valueIllformedLocaleException - if key is illegal
or value is ill-formedsetUnicodeLocaleKeyword(String, String)public ULocale.Builder setUnicodeLocaleKeyword(java.lang.String key, java.lang.String type)
Keys and types are converted to lower case.
Note:Setting the 'u' extension via setExtension(char, java.lang.String)
replaces all Unicode locale keywords with those defined in the
extension.
key - the Unicode locale keytype - the Unicode locale typeIllformedLocaleException - if key or type
is ill-formedjava.lang.NullPointerException - if key is nullsetExtension(char, String)public ULocale.Builder addUnicodeLocaleAttribute(java.lang.String attribute)
attribute - the attributejava.lang.NullPointerException - if attribute is nullIllformedLocaleException - if attribute is ill-formedsetExtension(char, String)public ULocale.Builder removeUnicodeLocaleAttribute(java.lang.String attribute)
Attribute comparision for removal is case-insensitive.
attribute - the attributejava.lang.NullPointerException - if attribute is nullIllformedLocaleException - if attribute is ill-formedsetExtension(char, String)public ULocale.Builder clear()
public ULocale.Builder clearExtensions()
setExtension(char, String)public ULocale build()
ULocale created from the fields set
on this builder.Copyright © 2016 Unicode, Inc. and others.