Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Inherited Constants](https://developer.android.com/reference/android/os/LocaleList#inhconstants) \| [Fields](https://developer.android.com/reference/android/os/LocaleList#lfields) \| [Ctors](https://developer.android.com/reference/android/os/LocaleList#pubctors) \| [Methods](https://developer.android.com/reference/android/os/LocaleList#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/os/LocaleList#inhmethods)

# LocaleList

*** ** * ** ***

` public final class LocaleList `   
` extends https://developer.android.com/reference/java/lang/Object ` ` implements https://developer.android.com/reference/android/os/Parcelable `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.os.LocaleList |

<br />

*** ** * ** ***

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

## Summary

### Inherited constants

From interface `https://developer.android.com/reference/android/os/Parcelable` `int` `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR`

Descriptor bit used with `https://developer.android.com/reference/android/os/Parcelable#describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int` `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`

Flag for use with `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`: 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)`".

| ### Fields ||
|---|---|
| ` public static final https://developer.android.com/reference/android/os/Parcelable.Creator<https://developer.android.com/reference/android/os/LocaleList>` | `https://developer.android.com/reference/android/os/LocaleList#CREATOR` <br /> |

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/android/os/LocaleList#LocaleList(java.util.Locale[])(https://developer.android.com/reference/java/util/Locale list) ` Creates a new `https://developer.android.com/reference/android/os/LocaleList`. |

| ### Public methods ||
|---|---|
| ` int` | ` https://developer.android.com/reference/android/os/LocaleList#describeContents()() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| ` boolean` | ` https://developer.android.com/reference/android/os/LocaleList#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object other) ` Indicates whether some other object is "equal to" this one. |
| ` static https://developer.android.com/reference/android/os/LocaleList` | ` https://developer.android.com/reference/android/os/LocaleList#forLanguageTags(java.lang.String)(https://developer.android.com/reference/java/lang/String list) ` Generates a new LocaleList with the given language tags. |
| ` https://developer.android.com/reference/java/util/Locale` | ` https://developer.android.com/reference/android/os/LocaleList#get(int)(int index) ` Retrieves the `https://developer.android.com/reference/java/util/Locale` at the specified index. |
| ` static https://developer.android.com/reference/android/os/LocaleList` | ` https://developer.android.com/reference/android/os/LocaleList#getAdjustedDefault()() ` Returns the default locale list, adjusted by moving the default locale to its first position. |
| ` static https://developer.android.com/reference/android/os/LocaleList` | ` https://developer.android.com/reference/android/os/LocaleList#getDefault()() ` The result is guaranteed to include the default Locale returned by Locale.getDefault(), but not necessarily at the top of the list. |
| ` static https://developer.android.com/reference/android/os/LocaleList` | ` https://developer.android.com/reference/android/os/LocaleList#getEmptyLocaleList()() ` Retrieve an empty instance of `https://developer.android.com/reference/android/os/LocaleList`. |
| ` https://developer.android.com/reference/java/util/Locale` | ` https://developer.android.com/reference/android/os/LocaleList#getFirstMatch(java.lang.String[])(https://developer.android.com/reference/java/lang/String supportedLocales) ` Returns the first match in the locale list given an unordered array of supported locales in BCP 47 format. |
| ` int` | ` https://developer.android.com/reference/android/os/LocaleList#hashCode()() ` Returns a hash code value for the object. |
| ` int` | ` https://developer.android.com/reference/android/os/LocaleList#indexOf(java.util.Locale)(https://developer.android.com/reference/java/util/Locale locale) ` Searches this `https://developer.android.com/reference/android/os/LocaleList` for the specified `https://developer.android.com/reference/java/util/Locale` and returns the index of the first occurrence. |
| ` boolean` | ` https://developer.android.com/reference/android/os/LocaleList#isEmpty()() ` Returns whether the `https://developer.android.com/reference/android/os/LocaleList` contains no `https://developer.android.com/reference/java/util/Locale` items. |
| ` static boolean` | ` https://developer.android.com/reference/android/os/LocaleList#isPseudoLocale(android.icu.util.ULocale)(https://developer.android.com/reference/android/icu/util/ULocale locale) ` Returns true if locale is a pseudo-locale, false otherwise. |
| ` static boolean` | ` https://developer.android.com/reference/android/os/LocaleList#matchesLanguageAndScript(java.util.Locale,%20java.util.Locale)(https://developer.android.com/reference/java/util/Locale supported, https://developer.android.com/reference/java/util/Locale desired) ` Determine whether two locales are considered a match, even if they are not exactly equal. |
| ` static void` | ` https://developer.android.com/reference/android/os/LocaleList#setDefault(android.os.LocaleList)(https://developer.android.com/reference/android/os/LocaleList locales) ` Also sets the default locale by calling Locale.setDefault() with the first locale in the list. |
| ` int` | ` https://developer.android.com/reference/android/os/LocaleList#size()() ` Returns the number of `https://developer.android.com/reference/java/util/Locale` items in this `https://developer.android.com/reference/android/os/LocaleList`. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/os/LocaleList#toLanguageTags()() ` Retrieves a String representation of the language tags in this list. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/os/LocaleList#toString()() ` Returns a string representation of the object. |
| ` void` | ` https://developer.android.com/reference/android/os/LocaleList#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int parcelableFlags) ` Flatten this object in to a Parcel. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.
From interface ` https://developer.android.com/reference/android/os/Parcelable ` ` abstract int` ` https://developer.android.com/reference/android/os/Parcelable#describeContents()() `

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
` abstract void` ` https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)(https://developer.android.com/reference/android/os/Parcel dest, int flags) `

Flatten this object in to a Parcel.

## Fields

### CREATOR

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final Creator<LocaleList> CREATOR
```

<br />

<br />

## Public constructors

### LocaleList

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public LocaleList (Locale... list)
```

Creates a new `https://developer.android.com/reference/android/os/LocaleList`. If two or more same locales are passed, the repeated locales will be dropped.

For empty lists of `https://developer.android.com/reference/java/util/Locale` items it is better to use `https://developer.android.com/reference/android/os/LocaleList#getEmptyLocaleList()`, which returns a pre-constructed empty list.

<br />

<br />

| Parameters ||
|---|---|
| `list` | `Locale`: This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/NullPointerException` | if any of the input locales is `null`. |

## Public methods

### describeContents

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int describeContents ()
```

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of `https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)`, the return value of this method must include the `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` bit.

<br />

| Returns ||
|---|---|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or - `https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR` |

### equals

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equals (Object other)
```

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.

<br />

| Parameters ||
|---|---|
| `other` | `Object`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### forLanguageTags

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static LocaleList forLanguageTags (String list)
```

Generates a new LocaleList with the given language tags.

<br />

| Parameters ||
|---|---|
| `list` | `String`: The language tags to be included as a single `https://developer.android.com/reference/java/lang/String` separated by commas. This value may be `null`. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/os/LocaleList` | A new instance with the `https://developer.android.com/reference/java/util/Locale` items identified by the given tags. This value cannot be `null`. <br /> |

### get

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Locale get (int index)
```

Retrieves the `https://developer.android.com/reference/java/util/Locale` at the specified index.

<br />

| Parameters ||
|---|---|
| `index` | `int`: The position to retrieve. <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Locale` | The `https://developer.android.com/reference/java/util/Locale` in the given index. <br /> |

### getAdjustedDefault

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static LocaleList getAdjustedDefault ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/os/LocaleList` | This value cannot be `null`. <br /> |

### getDefault

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static LocaleList getDefault ()
```

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.

<br />

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/os/LocaleList` | This value cannot be `null`. <br /> |

### getEmptyLocaleList

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static LocaleList getEmptyLocaleList ()
```

Retrieve an empty instance of `https://developer.android.com/reference/android/os/LocaleList`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/android/os/LocaleList` | This value cannot be `null`. <br /> |

### getFirstMatch

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public Locale getFirstMatch (String[] supportedLocales)
```

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

<br />

| Parameters ||
|---|---|
| `supportedLocales` | `String` <br /> |

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/Locale` | The first `https://developer.android.com/reference/java/util/Locale` from this list that appears in the given array, or `null` if the `https://developer.android.com/reference/android/os/LocaleList` is empty. <br /> |

### hashCode

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int hashCode ()
```

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `https://developer.android.com/reference/java/util/HashMap`.

The general contract of `hashCode` is:

- Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce the same integer result.
- It is *not* required that if two objects are unequal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### indexOf

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int indexOf (Locale locale)
```

Searches this `https://developer.android.com/reference/android/os/LocaleList` for the specified `https://developer.android.com/reference/java/util/Locale` and returns the index of the first occurrence.

<br />

| Parameters ||
|---|---|
| `locale` | `Locale`: The `https://developer.android.com/reference/java/util/Locale` to search for. <br /> |

| Returns ||
|---|---|
| `int` | The index of the first occurrence of the `https://developer.android.com/reference/java/util/Locale` or `-1` if the item wasn't found. Value is -1 or greater <br /> |

### isEmpty

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isEmpty ()
```

Returns whether the `https://developer.android.com/reference/android/os/LocaleList` contains no `https://developer.android.com/reference/java/util/Locale` items.

<br />

| Returns ||
|---|---|
| `boolean` | `true` if this `https://developer.android.com/reference/android/os/LocaleList` has no `https://developer.android.com/reference/java/util/Locale` items, `false` otherwise. <br /> |

### isPseudoLocale

Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static boolean isPseudoLocale (ULocale locale)
```

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

<br />

| Parameters ||
|---|---|
| `locale` | `ULocale`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | <br /> |

### matchesLanguageAndScript

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static boolean matchesLanguageAndScript (Locale supported, 
                Locale desired)
```

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\]

<br />

| Parameters ||
|---|---|
| `supported` | `Locale`: The supported `https://developer.android.com/reference/java/util/Locale` to be compared. This value cannot be `null`. <br /> |
| `desired` | `Locale`: The desired `https://developer.android.com/reference/java/util/Locale` to be compared. This value cannot be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | True if they match, false otherwise. <br /> |

### setDefault

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static void setDefault (LocaleList locales)
```

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

<br />

| Parameters ||
|---|---|
| `locales` | `LocaleList`: This value cannot be `null`. <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the input is empty. |
| `https://developer.android.com/reference/java/lang/NullPointerException` | if the input is `null`. |

### size

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int size ()
```

Returns the number of `https://developer.android.com/reference/java/util/Locale` items in this `https://developer.android.com/reference/android/os/LocaleList`.

<br />

| Returns ||
|---|---|
| `int` | Value is 0 or greater <br /> |

### toLanguageTags

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toLanguageTags ()
```

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

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value cannot be `null`. <br /> |

### toString

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String toString ()
```

Returns a string representation of the object.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | a string representation of the object. <br /> |

### writeToParcel

Added in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public void writeToParcel (Parcel dest, 
                int parcelableFlags)
```

Flatten this object in to a Parcel.

<br />

| Parameters ||
|---|---|
| `dest` | `Parcel`: The Parcel in which the object should be written. This value cannot be `null`. <br /> |
| `parcelableFlags` | `int`: Additional flags about how the object should be written. May be 0 or `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: - `https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE` |