Skip to content

Most visited

Recently visited

navigation

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

From interface android.os.Parcelable

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

From class java.lang.Object
From interface android.os.Parcelable

Fields

CREATOR

added in API level 24
Creator<LocaleList> CREATOR

Public constructors

LocaleList

added in API level 24
LocaleList (Locale... list)

Creates a new LocaleList.

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

Parameters
list Locale

This value must never be null.

Throws
NullPointerException if any of the input locales is null.
IllegalArgumentException if any of the input locales repeat.

Public methods

describeContents

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

equals

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

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Parameters
other Object: the reference object with which to compare.

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

forLanguageTags

added in API level 24
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 will never be null.

get

added in API level 24
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
LocaleList getAdjustedDefault ()

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

Returns
LocaleList

This value will never be null.

getDefault

added in API level 24
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 will never be null.

getEmptyLocaleList

added in API level 24
LocaleList getEmptyLocaleList ()

Retrieve an empty instance of LocaleList.

Returns
LocaleList

This value will never be null.

getFirstMatch

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

This value may be null.

hashCode

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

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Returns
int a hash code value for this object.

indexOf

added in API level 24
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
boolean isEmpty ()

Returns whether the LocaleList contains no Locale items.

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

setDefault

added in API level 24
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 must never be null.

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

size

added in API level 24
int size ()

Returns the number of Locale items in this LocaleList.

Returns
int

toLanguageTags

added in API level 24
String toLanguageTags ()

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

Returns
String

This value will never be null.

toString

added in API level 24
String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.

writeToParcel

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

parcelableFlags int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE.

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.