Package com.ibm.icu.text

Class LocaleDisplayNames.UiListItem

java.lang.Object

com.ibm.icu.text.LocaleDisplayNames.UiListItem

Enclosing class:

LocaleDisplayNames

public static class LocaleDisplayNames.UiListItem
extends Object

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

Status:

Stable ICU 55.

Field Summary

Fields

Modifier and Type	Field	Description
ULocale	minimized	Returns the minimized locale for an input locale, such as sr-Cyrl → sr
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
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').
String	nameInSelf	Returns the name of the modified locale in itself, such as "English (US)" (for 'en-US').

Constructor Summary

Constructors

Constructor	Description
UiListItem(ULocale minimized, ULocale modified, String nameInDisplayLocale, String nameInSelf)	Constructor, normally only called internally.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
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()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

minimized

public final ULocale minimized

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

Status:

Stable ICU 55.

modified

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

Status:

Stable ICU 55.

nameInDisplayLocale

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

Status:

Stable ICU 55.

nameInSelf

public final String nameInSelf

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

Status:

Stable ICU 55.

Constructor Detail

UiListItem

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

Constructor, normally only called internally.

Parameters:

minimized - locale for an input locale

modified - modified for an input locale

nameInDisplayLocale - name of the modified locale in the display locale

nameInSelf - name of the modified locale in itself

Status:

Stable ICU 55.

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Status:

Stable ICU 55.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Status:

Stable ICU 55.

toString

public String toString()

Overrides:

toString in class Object

Status:

Stable ICU 55.

getComparator

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:

inSelf - if true, compares the nameInSelf, otherwise the nameInDisplayLocale

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

Returns:

UiListItem comparator

Status:

Stable ICU 55.