Skip to content

Most visited

Recently visited

navigation

LocaleDisplayNames.UiListItem

public static class LocaleDisplayNames.UiListItem
extends Object

java.lang.Object
   ↳ android.icu.text.LocaleDisplayNames.UiListItem


Struct-like class used to return information for constructing a UI list, each corresponding to a locale.

Summary

Fields

public final ULocale minimized

Returns the minimized locale for an input locale, such as sr-Cyrl → sr

public final ULocale modified

Returns the modified locale for an input locale, such as sr → sr-Cyrl, where there is also an sr-Latn in the list

public final String nameInDisplayLocale

Returns the name of the modified locale in the display locale, such as "Englisch (VS)" (for 'en-US', where the display locale is 'de').

public final String nameInSelf

Returns the name of the modified locale in itself, such as "English (US)" (for 'en-US').

Public constructors

LocaleDisplayNames.UiListItem(ULocale minimized, ULocale modified, String nameInDisplayLocale, String nameInSelf)

Constructor, normally only called internally.

Public methods

boolean equals(Object obj)

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

static Comparator<LocaleDisplayNames.UiListItem> getComparator(Comparator<Object> comparator, boolean inSelf)

Return a comparator that compares the locale names for the display locale or the in-self names, depending on an input parameter.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

Inherited methods

From class java.lang.Object

Fields

minimized

added in API level 26
ULocale minimized

Returns the minimized locale for an input locale, such as sr-Cyrl → sr

modified

added in API level 26
ULocale modified

Returns the modified locale for an input locale, such as sr → sr-Cyrl, where there is also an sr-Latn in the list

nameInDisplayLocale

added in API level 26
String nameInDisplayLocale

Returns the name of the modified locale in the display locale, such as "Englisch (VS)" (for 'en-US', where the display locale is 'de').

nameInSelf

added in API level 26
String nameInSelf

Returns the name of the modified locale in itself, such as "English (US)" (for 'en-US').

Public constructors

LocaleDisplayNames.UiListItem

added in API level 26
LocaleDisplayNames.UiListItem (ULocale minimized, 
                ULocale modified, 
                String nameInDisplayLocale, 
                String nameInSelf)

Constructor, normally only called internally.

Parameters
minimized ULocale: locale for an input locale

modified ULocale: modified for an input locale

nameInDisplayLocale String: name of the modified locale in the display locale

nameInSelf String: name of the modified locale in itself

Public methods

equals

added in API level 26
boolean equals (Object obj)

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
obj Object: the reference object with which to compare.

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

getComparator

added in API level 26
Comparator<LocaleDisplayNames.UiListItem> getComparator (Comparator<Object> comparator, 
                boolean inSelf)

Return a comparator that compares the locale names for the display locale or the in-self names, depending on an input parameter.

Parameters
comparator Comparator: (meant for strings, but because Java Collator doesn't have <String>...)

inSelf boolean: if true, compares the nameInSelf, otherwise the nameInDisplayLocale

Returns
Comparator<LocaleDisplayNames.UiListItem> UiListItem comparator

hashCode

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

toString

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

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!

Follow Google Developers on WeChat

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 short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)