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.

Field Summary

Fields

Modifier and Type	Field and 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 and Description
UiListItem(ULocale minimized, ULocale modified, String nameInDisplayLocale, String nameInSelf) Constructor, normally only called internally.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
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 an integer hash code for this object.
String	toString() Returns a string containing a concise, human-readable description of this object.

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

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

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

nameInSelf

public final String nameInSelf

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

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

Method Detail

equals

public boolean equals(Object obj)

Compares this instance with the specified object and indicates if they are equal. In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than null is equal to null.

The default implementation returns true only if this == o. See Writing a correct equals method if you intend implementing your own equals method.

The general contract for the equals and Object.hashCode() methods is that if equals returns true for any two objects, then hashCode() must return the same value for these objects. This means that subclasses of Object usually override either both methods or neither of them.

Overrides:

equals in class Object

Parameters:

obj - the object to compare this instance with.

Returns:

true if the specified object is equal to this Object; false otherwise.

See Also:

Object.hashCode()

hashCode

public int hashCode()

Returns an integer hash code for this object. By contract, any two objects for which Object.equals(java.lang.Object) returns true must return the same hash code value. This means that subclasses of Object usually override both methods or neither method.

Note that hash values must not change over time unless information used in equals comparisons also changes.

See Writing a correct hashCode method if you intend implementing your own hashCode method.

Overrides:

hashCode in class Object

Returns:

this object's hash code.

See Also:

Object.equals(java.lang.Object)

toString

public String toString()

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Overrides:

toString in class Object

Returns:

a printable representation of this object.

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