# LocaleDisplayNames.UiListItem Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) # UiListItem *** ** * ** *** Kotlin\|[Java](https://developer.android.com/reference/android/icu/text/LocaleDisplayNames.UiListItem "View this page in Java") ``` open class UiListItem ``` |---|--------------------------------------------------------------------------------------------------------------------------------------------------| | [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) || | ↳ | [android.icu.text.LocaleDisplayNames.UiListItem](https://developer.android.com/reference/kotlin/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](https://developer.android.com/reference/kotlin/android/icu/text/LocaleDisplayNames.UiListItem#UiListItem(android.icu.util.ULocale,%20android.icu.util.ULocale,%20kotlin.String,%20kotlin.String))`(`minimized:` `[ULocale](https://developer.android.com/reference/kotlin/android/icu/util/ULocale.html#)!`, `modified:` `[ULocale](https://developer.android.com/reference/kotlin/android/icu/util/ULocale.html#)!`, `nameInDisplayLocale:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `nameInSelf:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Constructor, normally only called internally. | | Public methods || |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | open[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [equals](https://developer.android.com/reference/kotlin/android/icu/text/LocaleDisplayNames.UiListItem#equals(kotlin.Any))`(`other:` `[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)?`)` Indicates whether some other object is "equal to" this one. | | openstatic[Comparator](https://developer.android.com/reference/kotlin/java/util/Comparator.html#)\<[LocaleDisplayNames.UiListItem](https://developer.android.com/reference/kotlin/android/icu/text/LocaleDisplayNames.UiListItem#)!\>! | [getComparator](https://developer.android.com/reference/kotlin/android/icu/text/LocaleDisplayNames.UiListItem#getComparator(java.util.Comparator,%20kotlin.Boolean))`(`comparator:` `[Comparator](https://developer.android.com/reference/kotlin/java/util/Comparator.html#)<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)!>!`, `inSelf:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Return a comparator that compares the locale names for the display locale or the in-self names, depending on an input parameter. | | open[Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [hashCode](https://developer.android.com/reference/kotlin/android/icu/text/LocaleDisplayNames.UiListItem#hashCode())`()` Returns a hash code value for the object. | | open[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [toString](https://developer.android.com/reference/kotlin/android/icu/text/LocaleDisplayNames.UiListItem#toString())`()` Returns a string representation of the object. | | Properties || |-------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [ULocale](https://developer.android.com/reference/kotlin/android/icu/util/ULocale.html#)! | [minimized](https://developer.android.com/reference/kotlin/android/icu/text/LocaleDisplayNames.UiListItem#minimized:android.icu.util.ULocale) Returns the minimized locale for an input locale, such as sr-Cyrl → sr | | [ULocale](https://developer.android.com/reference/kotlin/android/icu/util/ULocale.html#)! | [modified](https://developer.android.com/reference/kotlin/android/icu/text/LocaleDisplayNames.UiListItem#modified:android.icu.util.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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [nameInDisplayLocale](https://developer.android.com/reference/kotlin/android/icu/text/LocaleDisplayNames.UiListItem#nameInDisplayLocale:kotlin.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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [nameInSelf](https://developer.android.com/reference/kotlin/android/icu/text/LocaleDisplayNames.UiListItem#nameInSelf:kotlin.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](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` UiListItem(     minimized: ULocale!,     modified: ULocale!,     nameInDisplayLocale: String!,     nameInSelf: String!) ``` Constructor, normally only called internally. | Parameters || |-----------------------|-------------------------------------------------------------------------------------------------------------------------------------| | `minimized` | [ULocale](https://developer.android.com/reference/kotlin/android/icu/util/ULocale.html#)!:locale for an input locale | | `modified` | [ULocale](https://developer.android.com/reference/kotlin/android/icu/util/ULocale.html#)!:modified for an input locale | | `nameInDisplayLocale` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:name of the modified locale in the display locale | | `nameInSelf` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!:name of the modified locale in itself | ## Public methods ### equals Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` 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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true`if this object is the same as the obj argument;`false`otherwise. | ### getComparator Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open static fun getComparator(     comparator: Comparator!,     inSelf: Boolean ): Comparator! ``` 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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html):if true, compares the nameInSelf, otherwise the nameInDisplayLocale | | `comparator` | [Comparator](https://developer.android.com/reference/kotlin/java/util/Comparator.html#)\<[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)!\>!:(meant for strings, but because Java Collator doesn't have \...) | | Return || |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| | [Comparator](https://developer.android.com/reference/kotlin/java/util/Comparator.html#)<[LocaleDisplayNames.UiListItem](https://developer.android.com/reference/kotlin/android/icu/text/LocaleDisplayNames.UiListItem#)!>! | UiListItem comparator | ### hashCode Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` 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](https://developer.android.com/reference/kotlin/java/util/HashMap.html#). 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](https://developer.android.com/reference/kotlin/java/lang/Object.html#equals(kotlin.Any))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](https://developer.android.com/reference/kotlin/java/lang/Object.html#equals(kotlin.Any))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](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | a hash code value for this object. | ### toString Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` open fun toString(): String ``` Returns a string representation of the object. | Return || |----------------------------------------------------------------------------------|----------------------------------------| | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | a string representation of the object. | ## Properties ### minimized Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` val minimized: ULocale! ``` Returns the minimized locale for an input locale, such as sr-Cyrl → sr ### modified Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` 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](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` 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](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) ``` val nameInSelf: String! ``` Returns the name of the modified locale in itself, such as "English (US)" (for 'en-US').