public final class LocaleList extends Object implements Parcelable
Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>
Modifier and Type | Field and Description |
---|---|
static Parcelable.Creator<LocaleList> |
CREATOR |
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_ELIDE_DUPLICATES, PARCELABLE_WRITE_RETURN_VALUE
Constructor and Description |
---|
LocaleList(Locale... list)
Creates a new
LocaleList . |
LocaleList(Locale topLocale,
LocaleList otherLocales)
Constructs a locale list, with the topLocale moved to the front if it already is
in otherLocales, or added to the front if it isn't.
|
Modifier and Type | Method and Description |
---|---|
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 |
getFirstMatchIndex(String[] supportedLocales) |
int |
getFirstMatchIndexWithEnglishSupported(Collection<String> supportedLocales) |
int |
getFirstMatchIndexWithEnglishSupported(String[] supportedLocales) |
Locale |
getFirstMatchWithEnglishSupported(String[] supportedLocales)
Same as getFirstMatch(), but with English assumed to be supported, even if it's not.
|
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 |
isPseudoLocalesOnly(String[] supportedLocales)
Returns true if the collection of locale tags only contains empty locales and pseudolocales.
|
static void |
setDefault(LocaleList locales)
Also sets the default locale by calling Locale.setDefault() with the first locale in the
list.
|
static void |
setDefault(LocaleList locales,
int localeIndex)
This may be used directly by system processes to set the default locale list for apps.
|
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.
|
public static final Parcelable.Creator<LocaleList> CREATOR
public LocaleList(Locale... list)
LocaleList
.
For empty lists of Locale
items it is better to use getEmptyLocaleList()
,
which returns a pre-constructed empty list.
NullPointerException
- if any of the input locales is null
.IllegalArgumentException
- if any of the input locales repeat.public LocaleList(Locale topLocale, LocaleList otherLocales)
public Locale get(int index)
Locale
at the specified index.index
- The position to retrieve.Locale
in the given index.public boolean isEmpty()
LocaleList
contains no Locale
items.true
if this LocaleList
has no Locale
items, false
otherwise.public int size()
Locale
items in this LocaleList
.public int indexOf(Locale locale)
LocaleList
for the specified Locale
and returns the index of
the first occurrence.public boolean equals(Object other)
Object
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
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.
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.
equals
in class Object
other
- the reference object with which to compare.true
if this object is the same as the obj
argument; false
otherwise.Object.hashCode()
,
HashMap
public int hashCode()
Object
HashMap
.
The general contract of hashCode
is:
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.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
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.
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
JavaTM programming language.)
hashCode
in class Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
public String toString()
Object
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())
public int describeContents()
Parcelable
Parcelable.writeToParcel(Parcel, int)
,
the return value of this method must include the
Parcelable.CONTENTS_FILE_DESCRIPTOR
bit.describeContents
in interface Parcelable
Parcelable.CONTENTS_FILE_DESCRIPTOR
public void writeToParcel(Parcel dest, int parcelableFlags)
Parcelable
writeToParcel
in interface Parcelable
dest
- The Parcel in which the object should be written.parcelableFlags
- Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE
.public String toLanguageTags()
public static LocaleList getEmptyLocaleList()
LocaleList
.public static LocaleList forLanguageTags(String list)
public Locale getFirstMatch(String[] supportedLocales)
Locale
from this list that appears in the given array, or
null
if the LocaleList
is empty.public int getFirstMatchIndex(String[] supportedLocales)
public Locale getFirstMatchWithEnglishSupported(String[] supportedLocales)
public int getFirstMatchIndexWithEnglishSupported(Collection<String> supportedLocales)
public int getFirstMatchIndexWithEnglishSupported(String[] supportedLocales)
public static boolean isPseudoLocalesOnly(String[] supportedLocales)
public static LocaleList getDefault()
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.
public static LocaleList getAdjustedDefault()
public static void setDefault(LocaleList locales)
NullPointerException
- if the input is null
.IllegalArgumentException
- if the input is empty.public static void setDefault(LocaleList locales, int localeIndex)