ULocale

PRIVATE_USE_EXTENSION

static val PRIVATE_USE_EXTENSION: Char

The key for the private use locale extension ('x').

Value: 120

UNICODE_LOCALE_EXTENSION

static val UNICODE_LOCALE_EXTENSION: Char

The key for Unicode locale extension ('u').

Value: 117

ULocale

ULocale(localeID: String!)

[icu] Constructs a ULocale from a RFC 3066 locale ID. The locale ID consists of optional language, script, country, and variant fields in that order, separated by underscores, followed by an optional keyword list. The script, if present, is four characters long-- this distinguishes it from a country code, which is two characters long. Other fields are distinguished by position as indicated by the underscores. The start of the keyword list is indicated by '@', and consists of two or more keyword/value pairs separated by semicolons(';').

This constructor does not canonicalize the localeID. So, for example, "zh__pinyin" remains unchanged instead of converting to "zh@collation=pinyin". By default ICU only recognizes the latter as specifying pinyin collation. Use #createCanonical or canonicalize if you need to canonicalize the localeID.

ULocale

ULocale(
    a: String!, 
    b: String!)

Convenience overload of ULocale(String, String, String) for compatibility with java.util.Locale.

ULocale

ULocale(
    a: String!, 
    b: String!, 
    c: String!)

Constructs a ULocale from a localeID constructed from the three 'fields' a, b, and c. These fields are concatenated using underscores to form a localeID of the form a_b_c, which is then handled like the localeID passed to ULocale(String localeID).

Java locale strings consisting of language, country, and variant will be handled by this form, since the country code (being shorter than four letters long) will not be interpreted as a script code. If a script code is present, the final argument ('c') will be interpreted as the country code. It is recommended that this constructor only be used to ease porting, and that clients instead use the single-argument constructor when constructing a ULocale from a localeID.

acceptLanguage

static fun acceptLanguage(
    acceptLanguageList: Array<ULocale!>!, 
    availableLocales: Array<ULocale!>!, 
    fallback: BooleanArray!
): ULocale!

[icu] Based on a list of acceptable locales, determine an available locale for the user. NullPointerException is thrown if acceptLanguageList or availableLocales is null. If fallback is non-null, it will contain true if a fallback locale (one not in the acceptLanguageList) was returned. The value on entry is ignored. ULocale will be one of the locales in availableLocales, or the ROOT ULocale if if a ROOT locale was used as a fallback (because nothing else in availableLocales matched). No ULocale array element should be null; behavior is undefined if this is the case.

acceptLanguage

static fun acceptLanguage(
    acceptLanguageList: Array<ULocale!>!, 
    fallback: BooleanArray!
): ULocale!

[icu] Based on an ordered array of acceptable locales, determine an available locale for the user. NullPointerException is thrown if acceptLanguageList or availableLocales is null. If fallback is non-null, it will contain true if a fallback locale (one not in the acceptLanguageList) was returned. The value on entry is ignored. ULocale will be one of the locales in availableLocales, or the ROOT ULocale if if a ROOT locale was used as a fallback (because nothing else in availableLocales matched). No ULocale array element should be null; behavior is undefined if this is the case. This function will choose a locale from the ULocale.getAvailableLocales() list as available.

acceptLanguage

static fun acceptLanguage(
    acceptLanguageList: String!, 
    availableLocales: Array<ULocale!>!, 
    fallback: BooleanArray!
): ULocale!

[icu] Based on a HTTP formatted list of acceptable locales, determine an available locale for the user. NullPointerException is thrown if acceptLanguageList or availableLocales is null. If fallback is non-null, it will contain true if a fallback locale (one not in the acceptLanguageList) was returned. The value on entry is ignored. ULocale will be one of the locales in availableLocales, or the ROOT ULocale if if a ROOT locale was used as a fallback (because nothing else in availableLocales matched). No ULocale array element should be null; behavior is undefined if this is the case.

acceptLanguage

static fun acceptLanguage(
    acceptLanguageList: String!, 
    fallback: BooleanArray!
): ULocale!

[icu] Based on a HTTP formatted list of acceptable locales, determine an available locale for the user. NullPointerException is thrown if acceptLanguageList or availableLocales is null. If fallback is non-null, it will contain true if a fallback locale (one not in the acceptLanguageList) was returned. The value on entry is ignored. ULocale will be one of the locales in availableLocales, or the ROOT ULocale if if a ROOT locale was used as a fallback (because nothing else in availableLocales matched). No ULocale array element should be null; behavior is undefined if this is the case. This function will choose a locale from the ULocale.getAvailableLocales() list as available.

addLikelySubtags

static fun addLikelySubtags(loc: ULocale!): ULocale!

[icu] Adds the likely subtags for a provided locale ID, per the algorithm described in the following CLDR technical report: http://www.unicode.org/reports/tr35/#Likely_Subtags If the provided ULocale instance is already in the maximal form, or there is no data available available for maximization, it will be returned. For example, "sh" cannot be maximized, since there is no reasonable maximization. Otherwise, a new ULocale instance with the maximal form is returned. Examples: "en" maximizes to "en_Latn_US" "de" maximizes to "de_Latn_DE" "sr" maximizes to "sr_Cyrl_RS" "zh_Hani" maximizes to "zh_Hani_CN"

canonicalize

static fun canonicalize(localeID: String!): String!

[icu] Returns the canonical name according to CLDR for the specified locale ID. This is used to convert POSIX and other legacy IDs to standard ICU form.

clone

fun clone(): Any!

This is for compatibility with Locale-- in actuality, since ULocale is immutable, there is no reason to clone it, so this API returns 'this'.

compareTo

fun compareTo(other: ULocale!): Int

Compares two ULocale for ordering.

Note: The order might change in future.

createCanonical

static fun createCanonical(locale: ULocale!): ULocale!

Creates a ULocale from the locale by first canonicalizing the locale according to CLDR.

createCanonical

static fun createCanonical(nonCanonicalID: String!): ULocale!

[icu] Creates a ULocale from the id by first canonicalizing the id according to CLDR.

equals

fun equals(other: Any?): Boolean

Returns true if the other object is another ULocale with the same full name. Note that since names are not canonicalized, two ULocales that function identically might not compare equal.

forLanguageTag

static fun forLanguageTag(languageTag: String!): ULocale!

Returns a locale for the specified IETF BCP 47 language tag string.

If the specified language tag contains any ill-formed subtags, the first such subtag and all following subtags are ignored. Compare to ULocale.Builder.setLanguageTag which throws an exception in this case.

The following conversions are performed:

• The language code "und" is mapped to language "".
• The portion of a private use subtag prefixed by "lvariant", if any, is removed and appended to the variant field in the result locale (without case normalization). If it is then empty, the private use subtag is discarded:

  ULocale loc;
        loc = ULocale.forLanguageTag("en-US-x-lvariant-icu4j);
        loc.getVariant(); // returns "ICU4J"
        loc.getExtension('x'); // returns null
   
        loc = Locale.forLanguageTag("de-icu4j-x-URP-lvariant-Abc-Def");
        loc.getVariant(); // returns "ICU4J_ABC_DEF"
        loc.getExtension('x'); // returns "urp"
    

• When the languageTag argument contains an extlang subtag, the first such subtag is used as the language, and the primary language subtag and other extlang subtags are ignored:

  ULocale.forLanguageTag("ar-aao").getLanguage(); // returns "aao"
        ULocale.forLanguageTag("en-abc-def-us").toString(); // returns "abc_US"
    

• Case is normalized. Language is normalized to lower case, script to title case, country to upper case, variant to upper case, and extensions to lower case.

This implements the 'Language-Tag' production of BCP 47, and so supports legacy language tags (marked as “Type: grandfathered” in BCP 47) (regular and irregular) as well as private use language tags.

Stand-alone private use tags are represented as empty language and extension 'x-whatever', and legacy tags are converted to their canonical replacements where they exist.

Note that a few legacy tags have no modern replacement; these will be converted using the fallback described in the first paragraph, so some information might be lost.

Note: there is no guarantee that toLanguageTag and forLanguageTag will round-trip.

forLocale

static fun forLocale(loc: Locale!): ULocale!

[icu] Returns a ULocale object for a java.util.Locale. The ULocale is canonicalized.

getAvailableLocales

static fun getAvailableLocales(): Array<ULocale!>!

[icu] Note: Unlike the Locale API, this returns an array of ULocale, not Locale.

Returns a list of all installed locales. This is equivalent to calling getAvailableLocalesByType with AvailableType.DEFAULT.

getAvailableLocalesByType

static fun getAvailableLocalesByType(type: ULocale.AvailableType!): MutableCollection<ULocale!>!

Returns a list of all installed locales according to the specified type.

getBaseName

fun getBaseName(): String!

[icu] Returns the (normalized) base name for this locale, like getName(), but without keywords.

getBaseName

static fun getBaseName(localeID: String!): String!

[icu] Returns the (normalized) base name for the specified locale, like getName(java.lang.String), but without keywords.

getCharacterOrientation

fun getCharacterOrientation(): String!

[icu] Returns this locale's layout orientation for characters. The possible values are "left-to-right", "right-to-left", "top-to-bottom" or "bottom-to-top".

getCountry

fun getCountry(): String!

Returns the country/region code for this locale, which will either be the empty string or an uppercase ISO 3166 2-letter code.

getCountry

static fun getCountry(localeID: String!): String!

[icu] Returns the country/region code for this locale, which will either be the empty string or an uppercase ISO 3166 2-letter code.

getDefault

static fun getDefault(): ULocale!

Returns the current default ULocale.

The default ULocale is synchronized to the default Java Locale. This method checks the current default Java Locale and returns an equivalent ULocale.

getDefault

static fun getDefault(category: ULocale.Category!): ULocale!

Returns the current default ULocale for the specified category.

getDisplayCountry

fun getDisplayCountry(): String!

Returns this locale's country localized for display in the default DISPLAY locale. Warning: this is for the region part of a valid locale ID; it cannot just be the region code (like "FR"). To get the display name for a region alone, or for other options, use LocaleDisplayNames instead.

getDisplayCountry

fun getDisplayCountry(displayLocale: ULocale!): String!

Returns this locale's country localized for display in the provided locale. Warning: this is for the region part of a valid locale ID; it cannot just be the region code (like "FR"). To get the display name for a region alone, or for other options, use LocaleDisplayNames instead.

getDisplayCountry

static fun getDisplayCountry(
    localeID: String!, 
    displayLocale: ULocale!
): String!

[icu] Returns a locale's country localized for display in the provided locale. Warning: this is for the region part of a valid locale ID; it cannot just be the region code (like "FR"). To get the display name for a region alone, or for other options, use LocaleDisplayNames instead. This is a cover for the ICU4C API.

getDisplayCountry

static fun getDisplayCountry(
    localeID: String!, 
    displayLocaleID: String!
): String!

[icu] Returns a locale's country localized for display in the provided locale. Warning: this is for the region part of a valid locale ID; it cannot just be the region code (like "FR"). To get the display name for a region alone, or for other options, use LocaleDisplayNames instead. This is a cover for the ICU4C API.

getDisplayKeyword

static fun getDisplayKeyword(keyword: String!): String!

[icu] Returns a keyword localized for display in the default DISPLAY locale.

getDisplayKeyword

static fun getDisplayKeyword(
    keyword: String!, 
    displayLocale: ULocale!
): String!

[icu] Returns a keyword localized for display in the specified locale.

getDisplayKeyword

static fun getDisplayKeyword(
    keyword: String!, 
    displayLocaleID: String!
): String!

[icu] Returns a keyword localized for display in the specified locale.

getDisplayKeywordValue

fun getDisplayKeywordValue(keyword: String!): String!

[icu] Returns a keyword value localized for display in the default DISPLAY locale.

getDisplayKeywordValue

fun getDisplayKeywordValue(
    keyword: String!, 
    displayLocale: ULocale!
): String!

[icu] Returns a keyword value localized for display in the specified locale.

getDisplayKeywordValue

static fun getDisplayKeywordValue(
    localeID: String!, 
    keyword: String!, 
    displayLocale: ULocale!
): String!

[icu] Returns a keyword value localized for display in the specified locale. This is a cover for the ICU4C API.

getDisplayKeywordValue

static fun getDisplayKeywordValue(
    localeID: String!, 
    keyword: String!, 
    displayLocaleID: String!
): String!

[icu] Returns a keyword value localized for display in the specified locale. This is a cover for the ICU4C API.

getDisplayLanguage

fun getDisplayLanguage(): String!

Returns this locale's language localized for display in the default DISPLAY locale.

getDisplayLanguage

fun getDisplayLanguage(displayLocale: ULocale!): String!

Returns this locale's language localized for display in the provided locale.

getDisplayLanguage

static fun getDisplayLanguage(
    localeID: String!, 
    displayLocale: ULocale!
): String!

[icu] Returns a locale's language localized for display in the provided locale. This is a cover for the ICU4C API.

getDisplayLanguage

static fun getDisplayLanguage(
    localeID: String!, 
    displayLocaleID: String!
): String!

[icu] Returns a locale's language localized for display in the provided locale. This is a cover for the ICU4C API.

getDisplayLanguageWithDialect

fun getDisplayLanguageWithDialect(): String!

[icu] Returns this locale's language localized for display in the default DISPLAY locale. If a dialect name is present in the data, then it is returned.

getDisplayLanguageWithDialect

fun getDisplayLanguageWithDialect(displayLocale: ULocale!): String!

[icu] Returns this locale's language localized for display in the provided locale. If a dialect name is present in the data, then it is returned.

getDisplayLanguageWithDialect

static fun getDisplayLanguageWithDialect(
    localeID: String!, 
    displayLocale: ULocale!
): String!

[icu] Returns a locale's language localized for display in the provided locale. If a dialect name is present in the data, then it is returned. This is a cover for the ICU4C API.

getDisplayLanguageWithDialect

static fun getDisplayLanguageWithDialect(
    localeID: String!, 
    displayLocaleID: String!
): String!

[icu] Returns a locale's language localized for display in the provided locale. If a dialect name is present in the data, then it is returned. This is a cover for the ICU4C API.

getDisplayName

fun getDisplayName(): String!

Returns this locale name localized for display in the default DISPLAY locale.

getDisplayName

fun getDisplayName(displayLocale: ULocale!): String!

Returns this locale name localized for display in the provided locale.

getDisplayName

static fun getDisplayName(
    localeID: String!, 
    displayLocale: ULocale!
): String!

[icu] Returns the locale ID localized for display in the provided locale. This is a cover for the ICU4C API.

getDisplayName

static fun getDisplayName(
    localeID: String!, 
    displayLocaleID: String!
): String!

[icu] Returns the locale ID localized for display in the provided locale. This is a cover for the ICU4C API.

getDisplayNameWithDialect

fun getDisplayNameWithDialect(): String!

[icu] Returns this locale name localized for display in the default DISPLAY locale. If a dialect name is present in the locale data, then it is returned.

getDisplayNameWithDialect

fun getDisplayNameWithDialect(displayLocale: ULocale!): String!

[icu] Returns this locale name localized for display in the provided locale. If a dialect name is present in the locale data, then it is returned.

getDisplayNameWithDialect

static fun getDisplayNameWithDialect(
    localeID: String!, 
    displayLocale: ULocale!
): String!

[icu] Returns the locale ID localized for display in the provided locale. If a dialect name is present in the locale data, then it is returned. This is a cover for the ICU4C API.

getDisplayNameWithDialect

static fun getDisplayNameWithDialect(
    localeID: String!, 
    displayLocaleID: String!
): String!

[icu] Returns the locale ID localized for display in the provided locale. If a dialect name is present in the locale data, then it is returned. This is a cover for the ICU4C API.

getDisplayScript

fun getDisplayScript(): String!

Returns this locale's script localized for display in the default DISPLAY locale.

getDisplayScript

fun getDisplayScript(displayLocale: ULocale!): String!

Returns this locale's script localized for display in the provided locale.

getDisplayScript

static fun getDisplayScript(
    localeID: String!, 
    displayLocale: ULocale!
): String!

[icu] Returns a locale's script localized for display in the provided locale.

getDisplayScript

static fun getDisplayScript(
    localeID: String!, 
    displayLocaleID: String!
): String!

[icu] Returns a locale's script localized for display in the provided locale. This is a cover for the ICU4C API.

getDisplayVariant

fun getDisplayVariant(): String!

Returns this locale's variant localized for display in the default DISPLAY locale.

getDisplayVariant

fun getDisplayVariant(displayLocale: ULocale!): String!

Returns this locale's variant localized for display in the provided locale.

getDisplayVariant

static fun getDisplayVariant(
    localeID: String!, 
    displayLocale: ULocale!
): String!

[icu] Returns a locale's variant localized for display in the provided locale. This is a cover for the ICU4C API.

getDisplayVariant

static fun getDisplayVariant(
    localeID: String!, 
    displayLocaleID: String!
): String!

[icu] Returns a locale's variant localized for display in the provided locale. This is a cover for the ICU4C API.

getExtension

fun getExtension(key: Char): String!

Returns the extension (or private use) value associated with the specified key, or null if there is no extension associated with the key. To be well-formed, the key must be one of [0-9A-Za-z]. Keys are case-insensitive, so for example 'z' and 'Z' represent the same extension.

getExtensionKeys

fun getExtensionKeys(): MutableSet<Char!>!

Returns the set of extension keys associated with this locale, or the empty set if it has no extensions. The returned set is unmodifiable. The keys will all be lower-case.

getFallback

fun getFallback(): ULocale!

[icu] Returns the fallback locale for this locale. If this locale is root, returns null.

getFallback

static fun getFallback(localeID: String!): String!

[icu] Returns the fallback locale for the specified locale, which might be the empty string.

getISO3Country

fun getISO3Country(): String!

Returns a three-letter abbreviation for this locale's country/region. If the locale doesn't specify a country, returns the empty string. Otherwise, returns an uppercase ISO 3166 3-letter country code.

getISO3Country

static fun getISO3Country(localeID: String!): String!

[icu] Returns a three-letter abbreviation for this locale's country/region. If the locale doesn't specify a country, returns the empty string. Otherwise, returns an uppercase ISO 3166 3-letter country code.

getISO3Language

fun getISO3Language(): String!

Returns a three-letter abbreviation for this locale's language. If the locale doesn't specify a language, returns the empty string. Otherwise, returns a lowercase ISO 639-2/T language code. The ISO 639-2 language codes can be found on-line at ftp://dkuug.dk/i18n/iso-639-2.txt

getISO3Language

static fun getISO3Language(localeID: String!): String!

[icu] Returns a three-letter abbreviation for this locale's language. If the locale doesn't specify a language, returns the empty string. Otherwise, returns a lowercase ISO 639-2/T language code. The ISO 639-2 language codes can be found on-line at ftp://dkuug.dk/i18n/iso-639-2.txt

getISOCountries

static fun getISOCountries(): Array<String!>!

Returns a list of all 2-letter country codes defined in ISO 3166. Can be used to create Locales.

getISOLanguages

static fun getISOLanguages(): Array<String!>!

Returns a list of all unique language codes defined in ISO 639. They can be 2 or 3 letter codes, as defined by BCP 47, section 2.2.1. Can be used to create Locales. [NOTE: ISO 639 is not a stable standard-- some languages' codes have changed. The list this function returns includes both the new and the old codes for the languages whose codes have changed.]

getKeywordValue

fun getKeywordValue(keywordName: String!): String!

[icu] Returns the value for a keyword in this locale. If the keyword is not defined, returns null.

getKeywordValue

static fun getKeywordValue(
    localeID: String!, 
    keywordName: String!
): String!

[icu] Returns the value for a keyword in the specified locale. If the keyword is not defined, returns null. The locale name does not need to be normalized.

getKeywords

fun getKeywords(): MutableIterator<String!>!

[icu] Returns an iterator over keywords for this locale. If there are no keywords, returns null.

getKeywords

static fun getKeywords(localeID: String!): MutableIterator<String!>!

[icu] Returns an iterator over keywords for the specified locale. If there are no keywords, returns null.

getLanguage

fun getLanguage(): String!

Returns the language code for this locale, which will either be the empty string or a lowercase ISO 639 code.

getLanguage

static fun getLanguage(localeID: String!): String!

Returns the language code for the locale ID, which will either be the empty string or a lowercase ISO 639 code.

getLineOrientation

fun getLineOrientation(): String!

[icu] Returns this locale's layout orientation for lines. The possible values are "left-to-right", "right-to-left", "top-to-bottom" or "bottom-to-top".

getName

fun getName(): String!

[icu] Returns the (normalized) full name for this locale.

getName

static fun getName(localeID: String!): String!

[icu] Returns the (normalized) full name for the specified locale.

getScript

fun getScript(): String!

Returns the script code for this locale, which might be the empty string.

getScript

static fun getScript(localeID: String!): String!

[icu] Returns the script code for the specified locale, which might be the empty string.

getUnicodeLocaleAttributes

fun getUnicodeLocaleAttributes(): MutableSet<String!>!

Returns the set of unicode locale attributes associated with this locale, or the empty set if it has no attributes. The returned set is unmodifiable.

getUnicodeLocaleKeys

fun getUnicodeLocaleKeys(): MutableSet<String!>!

Returns the set of Unicode locale keys defined by this locale, or the empty set if this locale has none. The returned set is immutable. Keys are all lower case.

getUnicodeLocaleType

fun getUnicodeLocaleType(key: String!): String!

Returns the Unicode locale type associated with the specified Unicode locale key for this locale. Returns the empty string for keys that are defined with no type. Returns null if the key is not defined. Keys are case-insensitive. The key must be two alphanumeric characters ([0-9a-zA-Z]), or an IllegalArgumentException is thrown.

getVariant

fun getVariant(): String!

Returns the variant code for this locale, which might be the empty string.

getVariant

static fun getVariant(localeID: String!): String!

[icu] Returns the variant code for the specified locale, which might be the empty string.

hashCode

fun hashCode(): Int

Returns the hashCode.

isRightToLeft

fun isRightToLeft(): Boolean

[icu] Returns whether this locale's script is written right-to-left. If there is no script subtag, then the likely script is used, see addLikelySubtags(android.icu.util.ULocale). If no likely script is known, then false is returned.

A script is right-to-left according to the CLDR script metadata which corresponds to whether the script's letters have Bidi_Class=R or AL.

Returns true for "ar" and "en-Hebr", false for "zh" and "fa-Cyrl".

minimizeSubtags

static fun minimizeSubtags(loc: ULocale!): ULocale!

[icu] Minimizes the subtags for a provided locale ID, per the algorithm described in the following CLDR technical report: http://www.unicode.org/reports/tr35/#Likely_Subtags If the provided ULocale instance is already in the minimal form, or there is no data available for minimization, it will be returned. Since the minimization algorithm relies on proper maximization, see the comments for addLikelySubtags for reasons why there might not be any data. Examples:

"en_Latn_US" minimizes to "en"
 
  "de_Latn_US" minimizes to "de"
 
  "sr_Cyrl_RS" minimizes to "sr"
 
  "zh_Hant_TW" minimizes to "zh_TW" (The region is preferred to the
  script, and minimizing to "zh" would imply "zh_Hans_CN".) 

setKeywordValue

fun setKeywordValue(
    keyword: String!, 
    value: String!
): ULocale!

[icu] Given a keyword and a value, return a new locale with an updated keyword and value. If the keyword is null, this removes all keywords from the locale id. Otherwise, if the value is null, this removes the value for this keyword from the locale id. Otherwise, this adds/replaces the value for this keyword in the locale id. The keyword and value must not be empty.

Related: getBaseName() returns the locale ID string with all keywords removed.

setKeywordValue

static fun setKeywordValue(
    localeID: String!, 
    keyword: String!, 
    value: String!
): String!

Given a locale id, a keyword, and a value, return a new locale id with an updated keyword and value. If the keyword is null, this removes all keywords from the locale id. Otherwise, if the value is null, this removes the value for this keyword from the locale id. Otherwise, this adds/replaces the value for this keyword in the locale id. The keyword and value must not be empty.

Related: getBaseName(java.lang.String) returns the locale ID string with all keywords removed.

toLanguageTag

fun toLanguageTag(): String!

Returns a well-formed IETF BCP 47 language tag representing this locale.

If this ULocale has a language, script, country, or variant that does not satisfy the IETF BCP 47 language tag syntax requirements, this method handles these fields as described below:

Language: If language is empty, or not well-formed (for example "a" or "e2"), it will be emitted as "und" (Undetermined).

Script: If script is not well-formed (for example "12" or "Latin"), it will be omitted.

Country: If country is not well-formed (for example "12" or "USA"), it will be omitted.

Variant: If variant is well-formed, each sub-segment (delimited by '-' or '_') is emitted as a subtag. Otherwise:

• if all sub-segments match [0-9a-zA-Z]{1,8} (for example "WIN" or "Oracle_JDK_Standard_Edition"), the first ill-formed sub-segment and all following will be appended to the private use subtag. The first appended subtag will be "lvariant", followed by the sub-segments in order, separated by hyphen. For example, "x-lvariant-WIN", "Oracle-x-lvariant-JDK-Standard-Edition".
• if any sub-segment does not match [0-9a-zA-Z]{1,8}, the variant will be truncated and the problematic sub-segment and all following sub-segments will be omitted. If the remainder is non-empty, it will be emitted as a private use subtag as above (even if the remainder turns out to be well-formed). For example, "Solaris_isjustthecoolestthing" is emitted as "x-lvariant-Solaris", not as "solaris".

Note: Although the language tag created by this method is well-formed (satisfies the syntax requirements defined by the IETF BCP 47 specification), it is not necessarily a valid BCP 47 language tag. For example,

new Locale("xx", "YY").toLanguageTag();

toLegacyKey

static fun toLegacyKey(keyword: String!): String!

[icu] Converts the specified keyword (BCP 47 Unicode locale extension key, or legacy key) to the legacy key. For example, legacy key "collation" is returned for the input BCP 47 Unicode locale extension key "co".

toLegacyType

static fun toLegacyType(
    keyword: String!, 
    value: String!
): String!

[icu] Converts the specified keyword value (BCP 47 Unicode locale extension type, or legacy type or type alias) to the canonical legacy type. For example, the legacy type "phonebook" is returned for the input BCP 47 Unicode locale extension type "phonebk" with the keyword "collation" (or "co").

When the specified keyword is not recognized, but the specified value satisfies the syntax of legacy key, or when the specified keyword allows 'variable' type and the specified value satisfies the syntax, the lower-case version of the input value will be returned. For example, toLegacyType("Foo", "Bar") returns "bar", toLegacyType("vt", "00A4") returns "00a4".

toLocale

fun toLocale(): Locale!

[icu] Converts this ULocale object to a java.util.Locale.

toString

fun toString(): String

Returns a string representation of this object.

toUnicodeLocaleKey

static fun toUnicodeLocaleKey(keyword: String!): String!

[icu] Converts the specified keyword (legacy key, or BCP 47 Unicode locale extension key) to the equivalent BCP 47 Unicode locale extension key. For example, BCP 47 Unicode locale extension key "co" is returned for the input keyword "collation".

When the specified keyword is unknown, but satisfies the BCP syntax, then the lower-case version of the input keyword will be returned. For example, toUnicodeLocaleKey("ZZ") returns "zz".

toUnicodeLocaleType

static fun toUnicodeLocaleType(
    keyword: String!, 
    value: String!
): String!

[icu] Converts the specified keyword value (legacy type, or BCP 47 Unicode locale extension type) to the well-formed BCP 47 Unicode locale extension type for the specified keyword (category). For example, BCP 47 Unicode locale extension type "phonebk" is returned for the input keyword value "phonebook", with the keyword "collation" (or "co").

When the specified keyword is not recognized, but the specified value satisfies the syntax of the BCP 47 Unicode locale extension type, or when the specified keyword allows 'variable' type and the specified value satisfies the syntax, the lower-case version of the input value will be returned. For example, toUnicodeLocaleType("Foo", "Bar") returns "bar", toUnicodeLocaleType("variableTop", "00A4") returns "00a4".

CANADA

static val CANADA: ULocale!

Useful constant for country/region.

CANADA_FRENCH

static val CANADA_FRENCH: ULocale!

Useful constant for country/region.

CHINA

static val CHINA: ULocale!

Useful constant for country/region.

CHINESE

static val CHINESE: ULocale!

Useful constant for language.

ENGLISH

static val ENGLISH: ULocale!

Useful constant for language.

FRANCE

static val FRANCE: ULocale!

Useful constant for country/region.

FRENCH

static val FRENCH: ULocale!

Useful constant for language.

GERMAN

static val GERMAN: ULocale!

Useful constant for language.

GERMANY

static val GERMANY: ULocale!

Useful constant for country/region.

ITALIAN

static val ITALIAN: ULocale!

Useful constant for language.

ITALY

static val ITALY: ULocale!

Useful constant for country/region.

JAPAN

static val JAPAN: ULocale!

Useful constant for country/region.

JAPANESE

static val JAPANESE: ULocale!

Useful constant for language.

KOREA

static val KOREA: ULocale!

Useful constant for country/region.

KOREAN

static val KOREAN: ULocale!

Useful constant for language.

PRC

static val PRC: ULocale!

Useful constant for country/region.

ROOT

static val ROOT: ULocale!

The root ULocale.

SIMPLIFIED_CHINESE

static val SIMPLIFIED_CHINESE: ULocale!

Useful constant for language.

TAIWAN

static val TAIWAN: ULocale!

Useful constant for country/region.

TRADITIONAL_CHINESE

static val TRADITIONAL_CHINESE: ULocale!

Useful constant for language.

UK

static val UK: ULocale!

Useful constant for country/region.

US

static val US: ULocale!

Useful constant for country/region.