LocaleList

public final class LocaleList
extends Object implements Parcelable

java.lang.Object
   ↳ 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

Fields

public static final Creator<LocaleList> CREATOR

Public constructors

LocaleList(Locale... list)

Creates a new LocaleList.

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object other)

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

static LocaleList forLanguageTags(String list)

Generates a new LocaleList with the given language tags.

Locale get(int index)

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.getDefault(), but not necessarily at the top of the list.

static LocaleList getEmptyLocaleList()

Retrieve an empty instance of LocaleList.

Locale getFirstMatch(String[] supportedLocales)

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

int hashCode()

Returns a hash code value for the object.

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(ULocale locale)

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

static boolean matchesLanguageAndScript(Locale supported, Locale desired)

Determine whether two locales are considered a match, even if they are not exactly equal.

static void setDefault(LocaleList locales)

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

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()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int parcelableFlags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 24
public static final Creator<LocaleList> CREATOR

Public constructors

LocaleList

Added in API level 24
public LocaleList (Locale... list)

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.

Throws
NullPointerException if any of the input locales is null.

Public methods

describeContents

Added in API level 24
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 writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 24
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.

Parameters
other Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

forLanguageTags

Added in API level 24
public static LocaleList forLanguageTags (String list)

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.

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

get

Added in API level 24
public Locale get (int index)

Retrieves the Locale at the specified index.

Parameters
index int: The position to retrieve.

Returns
Locale The Locale in the given index.

getAdjustedDefault

Added in API level 24
public static LocaleList getAdjustedDefault ()

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

Returns
LocaleList This value cannot be null.

getDefault

Added in API level 24
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.

Returns
LocaleList This value cannot be null.

getEmptyLocaleList

Added in API level 24
public static LocaleList getEmptyLocaleList ()

Retrieve an empty instance of LocaleList.

Returns
LocaleList This value cannot be null.

getFirstMatch

Added in API level 24
public Locale getFirstMatch (String[] supportedLocales)

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

Parameters
supportedLocales String

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

Returns
int a hash code value for this object.

indexOf

Added in API level 24
public int indexOf (Locale locale)

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

Parameters
locale Locale: The Locale to search for.

Returns
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
public boolean isEmpty ()

Returns whether the LocaleList contains no Locale items.

Returns
boolean true if this LocaleList has no Locale items, false otherwise.

isPseudoLocale

Added in API level 29
public static boolean isPseudoLocale (ULocale locale)

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

Parameters
locale ULocale: This value may be null.

Returns
boolean

matchesLanguageAndScript

Added in API level 33
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]

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.

Returns
boolean True if they match, false otherwise.

setDefault

Added in API level 24
public static void setDefault (LocaleList locales)

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

Parameters
locales LocaleList: This value cannot be null.

Throws
NullPointerException if the input is null.
IllegalArgumentException if the input is empty.

size

Added in API level 24
public int size ()

Returns the number of Locale items in this LocaleList.

Returns
int Value is 0 or greater

toLanguageTags

Added in API level 24
public String toLanguageTags ()

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

Returns
String This value cannot be null.

toString

Added in API level 24
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 24
public void writeToParcel (Parcel dest, 
                int parcelableFlags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written. This value cannot be null.

parcelableFlags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES