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 \u2192 sr

public final ULocale modified

Returns the modified locale for an input locale, such as sr \u2192 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

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

Fields

minimized

Added in API level 26
public final ULocale minimized

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

modified

Added in API level 26
public final ULocale modified

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

nameInDisplayLocale

Added in API level 26
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').

nameInSelf

Added in API level 26
public final String nameInSelf

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

Public constructors

UiListItem

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

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

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

toString

Added in API level 26
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.