Added in API level 26

UiListItem

open class UiListItem
kotlin.Any
   ↳ android.icu.text.LocaleDisplayNames.UiListItem

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

Summary

Public constructors
UiListItem(minimized: ULocale!, modified: ULocale!, nameInDisplayLocale: String!, nameInSelf: String!)

Constructor, normally only called internally.
Public methods
open Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.
open static Comparator<LocaleDisplayNames.UiListItem!>!
getComparator(comparator: Comparator<Any!>!, inSelf: Boolean)

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

Returns a hash code value for the object.
open String

Returns a string representation of the object.
Properties
ULocale!

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

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

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

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

Public constructors

UiListItem

Added in API level 26
UiListItem(
    minimized: ULocale!, 
    modified: ULocale!, 
    nameInDisplayLocale: String!, 
    nameInSelf: String!)

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
open fun equals(other: Any?): Boolean

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 the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getComparator

Added in API level 26
open static fun getComparator(
    comparator: Comparator<Any!>!, 
    inSelf: Boolean
): Comparator<LocaleDisplayNames.UiListItem!>!

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

Parameters
inSelf Boolean: if true, compares the nameInSelf, otherwise the nameInDisplayLocale
comparator Comparator<Any!>!: (meant for strings, but because Java Collator doesn't have <String>...)
Return
Comparator<LocaleDisplayNames.UiListItem!>! UiListItem comparator

hashCode

Added in API level 26
open fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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.
Return
Int a hash code value for this object.

toString

Added in API level 26
open fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

Properties

minimized

Added in API level 26
val minimized: ULocale!

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

modified

Added in API level 26
val modified: ULocale!

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
val nameInDisplayLocale: String!

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
val nameInSelf: String!

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