# LocaleDisplayNames.UiListItem

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Fields](https://developer.android.com/reference/android/icu/text/LocaleDisplayNames.UiListItem#lfields)\|[Ctors](https://developer.android.com/reference/android/icu/text/LocaleDisplayNames.UiListItem#pubctors)\|[Methods](https://developer.android.com/reference/android/icu/text/LocaleDisplayNames.UiListItem#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/icu/text/LocaleDisplayNames.UiListItem#inhmethods)  

# LocaleDisplayNames.UiListItem

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/icu/text/LocaleDisplayNames.UiListItem "View this page in Kotlin")\|Java

`
public
static


class
LocaleDisplayNames.UiListItem
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


`

|---|------------------------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.icu.text.LocaleDisplayNames.UiListItem |

<br />

*** ** * ** ***

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

## Summary

|                                                                                                                                                                               ### Fields                                                                                                                                                                               ||
|---------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` public final `[ULocale](https://developer.android.com/reference/android/icu/util/ULocale) | [minimized](https://developer.android.com/reference/android/icu/text/LocaleDisplayNames.UiListItem#minimized) Returns the minimized locale for an input locale, such as sr-Cyrl \\u2192 sr                                                                                |
| ` public final `[ULocale](https://developer.android.com/reference/android/icu/util/ULocale) | [modified](https://developer.android.com/reference/android/icu/text/LocaleDisplayNames.UiListItem#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](https://developer.android.com/reference/java/lang/String)          | [nameInDisplayLocale](https://developer.android.com/reference/android/icu/text/LocaleDisplayNames.UiListItem#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](https://developer.android.com/reference/java/lang/String)          | [nameInSelf](https://developer.android.com/reference/android/icu/text/LocaleDisplayNames.UiListItem#nameInSelf) Returns the name of the modified locale in itself, such as "English (US)" (for 'en-US').                                                                  |

|                                                                                                                                                                                                                                                                                                     ### Public constructors                                                                                                                                                                                                                                                                                                      ||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|
| ` `[UiListItem](https://developer.android.com/reference/android/icu/text/LocaleDisplayNames.UiListItem#UiListItem(android.icu.util.ULocale,%20android.icu.util.ULocale,%20java.lang.String,%20java.lang.String))`(`[ULocale](https://developer.android.com/reference/android/icu/util/ULocale)` minimized, `[ULocale](https://developer.android.com/reference/android/icu/util/ULocale)` modified, `[String](https://developer.android.com/reference/java/lang/String)` nameInDisplayLocale, `[String](https://developer.android.com/reference/java/lang/String)` nameInSelf) ` Constructor, normally only called internally. |

|                                                                                                                                                                                                                                                                                                                                                ### Public methods                                                                                                                                                                                                                                                                                                                                                 ||
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` boolean`                                                                                                                                                                                                        | ` `[equals](https://developer.android.com/reference/android/icu/text/LocaleDisplayNames.UiListItem#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                                                                                                                                                                                                          |
| ` static `[Comparator](https://developer.android.com/reference/java/util/Comparator)`<`[LocaleDisplayNames.UiListItem](https://developer.android.com/reference/android/icu/text/LocaleDisplayNames.UiListItem)`>` | ` `[getComparator](https://developer.android.com/reference/android/icu/text/LocaleDisplayNames.UiListItem#getComparator(java.util.Comparator<java.lang.Object>,%20boolean))`(`[Comparator](https://developer.android.com/reference/java/util/Comparator)`<`[Object](https://developer.android.com/reference/java/lang/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](https://developer.android.com/reference/android/icu/text/LocaleDisplayNames.UiListItem#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                                                                                                                                                                                                |
| ` `[String](https://developer.android.com/reference/java/lang/String)                                                                                                                                             | ` `[toString](https://developer.android.com/reference/android/icu/text/LocaleDisplayNames.UiListItem#toString())`() ` Returns a string representation of the object.                                                                                                                                                                                                                                                                                                                           |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                          | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed.                   | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*.                                                                                             | ||

## Fields

### minimized

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public final ULocale minimized
```

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

<br />

### modified

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

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

<br />

### nameInDisplayLocale

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
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').

<br />

### nameInSelf

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public final String nameInSelf
```

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

<br />

## Public constructors

### UiListItem

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public UiListItem (ULocale minimized, 
                ULocale modified, 
                String nameInDisplayLocale, 
                String nameInSelf)
```

Constructor, normally only called internally.

<br />

|                                        Parameters                                         ||
|-----------------------|--------------------------------------------------------------------|
| `minimized`           | `ULocale`: locale for an input locale <br />                       |
| `modified`            | `ULocale`: modified for an input locale <br />                     |
| `nameInDisplayLocale` | `String`: name of the modified locale in the display locale <br /> |
| `nameInSelf`          | `String`: name of the modified locale in itself <br />             |

## Public methods

### equals

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

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

<br />

|                             Parameters                              ||
|-------|--------------------------------------------------------------|
| `obj` | `Object`: the reference object with which to compare. <br /> |

|                                         Returns                                          ||
|-----------|-------------------------------------------------------------------------------|
| `boolean` | `true`if this object is the same as the obj argument;`false`otherwise. <br /> |

### getComparator

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

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

<br />

|                                                  Parameters                                                  ||
|--------------|------------------------------------------------------------------------------------------------|
| `comparator` | `Comparator`: (meant for strings, but because Java Collator doesn't have \<String\>...) <br /> |
| `inSelf`     | `boolean`: if true, compares the nameInSelf, otherwise the nameInDisplayLocale <br />          |

|                                                                                                                Returns                                                                                                                ||
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|
| [Comparator](https://developer.android.com/reference/java/util/Comparator)`<`[LocaleDisplayNames.UiListItem](https://developer.android.com/reference/android/icu/text/LocaleDisplayNames.UiListItem)`>` | UiListItem comparator <br /> |

### hashCode

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
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](https://developer.android.com/reference/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](https://developer.android.com/reference/java/lang/Object#equals(java.lang.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](https://developer.android.com/reference/java/lang/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.

<br />

<br />

|                     Returns                      ||
|-------|-------------------------------------------|
| `int` | a hash code value for this object. <br /> |

### toString

Added in[API level 26](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public String toString ()
```

Returns a string representation of the object.

<br />

|                                                      Returns                                                      ||
|--------------------------------------------------------------------|-----------------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | a string representation of the object. <br /> |