Added in API level 24

LocaleList

---

Kotlin |Java

class LocaleList : Parcelable

kotlin.Any
↳	android.os.LocaleList

LocaleList is an immutable list of Locales, typically used to keep an ordered list of user preferences for locales.

Summary

Inherited constants

From class Parcelable Int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. Int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
LocaleList(vararg list: Locale!) Creates a new LocaleList.

Public methods
Int	describeContents()
Boolean	equals(other: Any?) Indicates whether some other object is "equal to" this one.
static LocaleList	forLanguageTags(list: String?) Generates a new LocaleList with the given language tags.
Locale!	get(index: Int) Retrieves the Locale at the specified index.
static LocaleList	getAdjustedDefault() Returns the default locale list, adjusted by moving the default locale to its first position.
static LocaleList	getDefault() The result is guaranteed to include the default Locale returned by Locale.
static LocaleList	getEmptyLocaleList() Retrieve an empty instance of LocaleList.
Locale?	getFirstMatch(supportedLocales: Array<String!>!) Returns the first match in the locale list given an unordered array of supported locales in BCP 47 format.
Int	hashCode()
Int	indexOf(locale: Locale!) Searches this LocaleList for the specified Locale and returns the index of the first occurrence.
Boolean	isEmpty() Returns whether the LocaleList contains no Locale items.
static Boolean	isPseudoLocale(locale: ULocale?) Returns true if locale is a pseudo-locale, false otherwise.
static Boolean	matchesLanguageAndScript(supported: Locale, desired: Locale) Determine whether two locales are considered a match, even if they are not exactly equal.
static Unit	setDefault(locales: LocaleList) Also sets the default locale by calling Locale.
Int	size() Returns the number of Locale items in this LocaleList.
String	toLanguageTags() Retrieves a String representation of the language tags in this list.
String	toString()
Unit	writeToParcel(dest: Parcel, parcelableFlags: Int)

Properties
static Parcelable.Creator<LocaleList!>	CREATOR

Public constructors

LocaleList

Added in API level 24

LocaleList(vararg list: Locale!)

Creates a new LocaleList. If two or more same locales are passed, the repeated locales will be dropped.

For empty lists of Locale items it is better to use getEmptyLocaleList(), which returns a pre-constructed empty list.

Parameters
list	Locale!: This value cannot be null.

Exceptions
java.lang.NullPointerException	if any of the input locales is null.

Public methods

describeContents

Added in API level 24

fun describeContents(): Int

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 24

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj	the reference object with which to compare.
other	Any?: This value may be null.

Return
Boolean	true if this object is the same as the obj argument; false otherwise.

forLanguageTags

Added in API level 24

static fun forLanguageTags(list: String?): LocaleList

Generates a new LocaleList with the given language tags.

Parameters
list	String?: The language tags to be included as a single String separated by commas. This value may be null.

Return
LocaleList	A new instance with the Locale items identified by the given tags. This value cannot be null.

get

Added in API level 24

fun get(index: Int): Locale!

Retrieves the Locale at the specified index.

Parameters
index	Int: The position to retrieve.

Return
Locale!	The Locale in the given index.

getAdjustedDefault

Added in API level 24

static fun getAdjustedDefault(): LocaleList

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

Return
LocaleList	This value cannot be null.

getDefault

Added in API level 24

static fun getDefault(): LocaleList

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 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.

Return
LocaleList	This value cannot be null.

getEmptyLocaleList

Added in API level 24

static fun getEmptyLocaleList(): LocaleList

Retrieve an empty instance of LocaleList.

Return
LocaleList	This value cannot be null.

getFirstMatch

Added in API level 24

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.

Return
Locale?	The first Locale from this list that appears in the given array, or null if the LocaleList is empty.

hashCode

Added in API level 24

fun hashCode(): Int

Return
Int	a hash code value for this object.

indexOf

Added in API level 24

fun indexOf(locale: Locale!): Int

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

Parameters
locale	Locale!: The Locale to search for.

Return
Int	The index of the first occurrence of the Locale or -1 if the item wasn't found. Value is -1 or greater

isEmpty

Added in API level 24

fun isEmpty(): Boolean

Returns whether the LocaleList contains no Locale items.

Return
Boolean	true if this LocaleList has no Locale items, false otherwise.

isPseudoLocale

Added in API level 29

static fun isPseudoLocale(locale: ULocale?): Boolean

Returns true if locale is a pseudo-locale, false otherwise.

Parameters
locale	ULocale?: This value may be null.

matchesLanguageAndScript

Added in API level 33

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]

Parameters
supported	Locale: The supported Locale to be compared. This value cannot be null.
desired	Locale: The desired Locale to be compared. This value cannot be null.

Return
Boolean	True if they match, false otherwise.

setDefault

Added in API level 24

static fun setDefault(locales: LocaleList): Unit

Also sets the default locale by calling Locale.setDefault() with the first locale in the list.

Parameters
locales	LocaleList: This value cannot be null.

Exceptions
java.lang.NullPointerException	if the input is null.
java.lang.IllegalArgumentException	if the input is empty.

size

Added in API level 24

fun size(): Int

Returns the number of Locale items in this LocaleList.

Return
Int	Value is 0 or greater

toLanguageTags

Added in API level 24

fun toLanguageTags(): String

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

Return
String	This value cannot be null.

toString

Added in API level 24

fun toString(): String

Return
String	a string representation of the object.

writeToParcel

Added in API level 24

fun writeToParcel(
    dest: Parcel, 
    parcelableFlags: Int
): Unit

Parameters
dest	Parcel: The Parcel in which the object should be written. This value cannot be null.
flags	Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 24

static val CREATOR: Parcelable.Creator<LocaleList!>