LocaleListCompat

java-static fun create(localeList: Array<Locale!>): LocaleListCompat

Creates a new instance of LocaleListCompat from the Locale array.

java-static fun forLanguageTags(list: String?): LocaleListCompat

Generates a new LocaleList with the given language tags.

Note that for API <24 only the first language tag will be used.

fun get(index: Int): Locale?

Retrieves the Locale at the specified index.

java-static fun getAdjustedDefault(): @Size(min = 1) LocaleListCompat

Returns the default locale list, adjusted by moving the default locale to its first position.

java-static fun getDefault(): @Size(min = 1) LocaleListCompat

The result is guaranteed to include the default Locale returned by Locale.getDefault(), but not necessarily at the top of the list. The default locale not being at the top of the list is an indication that the system has set the default locale to one of the user's other preferred locales, having concluded that the primary preference is not supported but a secondary preference is.

Note that for API >= 24 the default LocaleList would change if Locale.setDefault() is called. This method takes that into account by always checking the output of Locale.getDefault() and recalculating the default LocaleList if needed.

java-static fun getEmptyLocaleList(): LocaleListCompat

Retrieve an empty instance of LocaleListCompat.

fun getFirstMatch(supportedLocales: Array<String!>): Locale?

Returns the first match in the locale list given an unordered array of supported locales in BCP 47 format.

fun indexOf(locale: Locale?): @IntRange(from = "-1") Int

Searches this LocaleListCompat for the specified Locale and returns the index of the first occurrence.

fun isEmpty(): Boolean

Returns whether the LocaleListCompat contains no Locale items.

@RequiresApi(value = 21)
java-static fun matchesLanguageAndScript(supported: Locale, desired: Locale): Boolean

Determine whether two locales are considered a match, even if they are not exactly equal. They are considered as a match when both of their languages and scripts (explicit or inferred) are identical. This means that a user would be able to understand the content written in the supported locale even if they say they prefer the desired locale. E.g. [zh-HK] matches [zh-Hant]; [en-US] matches [en-CA].

fun size(): @IntRange(from = 0) Int

Returns the number of Locale items in this LocaleListCompat.

fun toLanguageTags(): String

Retrieves a String representation of the language tags in this list.

fun unwrap(): Any?

Gets the underlying framework object.

@RequiresApi(value = 24)
java-static fun wrap(localeList: LocaleList): LocaleListCompat

Creates a new instance of LocaleListCompat from the Locale list.