Package com.ibm.icu.text
Class LocaleDisplayNames
java.lang.Object
com.ibm.icu.text.LocaleDisplayNames
Returns display names of ULocales and components of ULocales. For
more information on language, script, region, variant, key, and
values, see
ULocale
.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
Enum used ingetInstance(ULocale, DialectHandling)
.static class
Struct-like class used to return information for constructing a UI list, each corresponding to a locale. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Deprecated.This API is ICU internal only. -
Method Summary
Modifier and TypeMethodDescriptionabstract DisplayContext
Returns the current value for a specified DisplayContext.Type.abstract LocaleDisplayNames.DialectHandling
Returns the dialect handling used in the display names.static LocaleDisplayNames
getInstance
(ULocale locale) Convenience overload ofgetInstance(ULocale, DialectHandling)
that specifies STANDARD dialect handling.static LocaleDisplayNames
getInstance
(ULocale locale, DisplayContext... contexts) Returns an instance of LocaleDisplayNames that returns names formatted for the provided locale, using the provided DisplayContext settingsstatic LocaleDisplayNames
getInstance
(ULocale locale, LocaleDisplayNames.DialectHandling dialectHandling) Returns an instance of LocaleDisplayNames that returns names formatted for the provided locale, using the provided dialectHandling.static LocaleDisplayNames
getInstance
(Locale locale) Convenience overload ofgetInstance(Locale, DisplayContext...)
that specifiesDisplayContext.STANDARD_NAMES
.static LocaleDisplayNames
getInstance
(Locale locale, DisplayContext... contexts) Returns an instance of LocaleDisplayNames that returns names formatted for the providedLocale
, using the provided DisplayContext settingsabstract ULocale
Returns the locale used to determine the display names.getUiList
(Set<ULocale> localeSet, boolean inSelf, Comparator<Object> collator) Return a list of information used to construct a UI list of locale names.abstract List
<LocaleDisplayNames.UiListItem> getUiListCompareWholeItems
(Set<ULocale> localeSet, Comparator<LocaleDisplayNames.UiListItem> comparator) Return a list of information used to construct a UI list of locale names, providing more access to control the sorting.abstract String
keyDisplayName
(String key) Returns the display name of the provided locale key.abstract String
keyValueDisplayName
(String key, String value) Returns the display name of the provided value (used with the provided key).abstract String
languageDisplayName
(String lang) Returns the display name of the provided language code.abstract String
localeDisplayName
(ULocale locale) Returns the display name of the provided ulocale.abstract String
localeDisplayName
(String localeId) Returns the display name of the provided locale id.abstract String
localeDisplayName
(Locale locale) Returns the display name of the provided locale.abstract String
regionDisplayName
(String region) Returns the display name of the provided region code.abstract String
scriptDisplayName
(int scriptCode) Returns the display name of the provided script code.abstract String
scriptDisplayName
(String script) Returns the display name of the provided script code.scriptDisplayNameInContext
(String script) Deprecated.This API is ICU internal only.abstract String
variantDisplayName
(String variant) Returns the display name of the provided variant.
-
Constructor Details
-
LocaleDisplayNames
Deprecated.This API is ICU internal only.Sole constructor. (For invocation by subclass constructors, typically implicit.)
-
-
Method Details
-
getInstance
Convenience overload ofgetInstance(ULocale, DialectHandling)
that specifies STANDARD dialect handling.- Parameters:
locale
- the display locale- Returns:
- a LocaleDisplayNames instance
-
getInstance
Convenience overload ofgetInstance(Locale, DisplayContext...)
that specifiesDisplayContext.STANDARD_NAMES
.- Parameters:
locale
- the displayLocale
- Returns:
- a LocaleDisplayNames instance
-
getInstance
public static LocaleDisplayNames getInstance(ULocale locale, LocaleDisplayNames.DialectHandling dialectHandling) Returns an instance of LocaleDisplayNames that returns names formatted for the provided locale, using the provided dialectHandling.- Parameters:
locale
- the display localedialectHandling
- how to select names for locales- Returns:
- a LocaleDisplayNames instance
-
getInstance
Returns an instance of LocaleDisplayNames that returns names formatted for the provided locale, using the provided DisplayContext settings- Parameters:
locale
- the display localecontexts
- one or more context settings (e.g. for dialect handling, capitalization, etc.- Returns:
- a LocaleDisplayNames instance
-
getInstance
Returns an instance of LocaleDisplayNames that returns names formatted for the providedLocale
, using the provided DisplayContext settings- Parameters:
locale
- the displayLocale
contexts
- one or more context settings (e.g. for dialect handling, capitalization, etc.- Returns:
- a LocaleDisplayNames instance
-
getLocale
Returns the locale used to determine the display names. This is not necessarily the same locale passed togetInstance(com.ibm.icu.util.ULocale)
.- Returns:
- the display locale
-
getDialectHandling
Returns the dialect handling used in the display names.- Returns:
- the dialect handling enum
-
getContext
Returns the current value for a specified DisplayContext.Type.- Parameters:
type
- the DisplayContext.Type whose value to return- Returns:
- the current DisplayContext setting for the specified type
-
localeDisplayName
Returns the display name of the provided ulocale. When no display names are available for all or portions of the original locale ID, those portions may be used directly (possibly in a more canonical form) as part of the returned display name.- Parameters:
locale
- the locale whose display name to return- Returns:
- the display name of the provided locale
-
localeDisplayName
Returns the display name of the provided locale. When no display names are available for all or portions of the original locale ID, those portions may be used directly (possibly in a more canonical form) as part of the returned display name.- Parameters:
locale
- the locale whose display name to return- Returns:
- the display name of the provided locale
-
localeDisplayName
Returns the display name of the provided locale id. When no display names are available for all or portions of the original locale ID, those portions may be used directly (possibly in a more canonical form) as part of the returned display name.- Parameters:
localeId
- the id of the locale whose display name to return- Returns:
- the display name of the provided locale
-
languageDisplayName
Returns the display name of the provided language code.- Parameters:
lang
- the language code- Returns:
- the display name of the provided language code
-
scriptDisplayName
Returns the display name of the provided script code.- Parameters:
script
- the script code- Returns:
- the display name of the provided script code
-
scriptDisplayNameInContext
Deprecated.This API is ICU internal only.Returns the display name of the provided script code when used in the context of a full locale name.- Parameters:
script
- the script code- Returns:
- the display name of the provided script code
-
scriptDisplayName
Returns the display name of the provided script code. SeeUScript
for recognized script codes.- Parameters:
scriptCode
- the script code number- Returns:
- the display name of the provided script code
-
regionDisplayName
Returns the display name of the provided region code.- Parameters:
region
- the region code- Returns:
- the display name of the provided region code
-
variantDisplayName
Returns the display name of the provided variant.- Parameters:
variant
- the variant string- Returns:
- the display name of the provided variant
-
keyDisplayName
Returns the display name of the provided locale key.- Parameters:
key
- the locale key name- Returns:
- the display name of the provided locale key
-
keyValueDisplayName
Returns the display name of the provided value (used with the provided key).- Parameters:
key
- the locale key namevalue
- the locale key's value- Returns:
- the display name of the provided value
-
getUiList
public List<LocaleDisplayNames.UiListItem> getUiList(Set<ULocale> localeSet, boolean inSelf, Comparator<Object> collator) Return a list of information used to construct a UI list of locale names.- Parameters:
localeSet
- a list of locales to present in a UI list. The casing uses the settings in the LocaleDisplayNames instance.inSelf
- if true, compares the nameInSelf, otherwise the nameInDisplayLocale. Set depending on which field (displayLocale vs self) is to show up in the UI. If both are to show up in the UI, then it should be the one used for the primary sort order.collator
- how to collate—should normally be Collator.getInstance(getDisplayLocale())- Returns:
- an ordered list of UiListItems.
- Throws:
IllformedLocaleException
- if any of the locales in localeSet are malformed.
-
getUiListCompareWholeItems
public abstract List<LocaleDisplayNames.UiListItem> getUiListCompareWholeItems(Set<ULocale> localeSet, Comparator<LocaleDisplayNames.UiListItem> comparator) Return a list of information used to construct a UI list of locale names, providing more access to control the sorting. Normally use getUiList instead.- Parameters:
localeSet
- a list of locales to present in a UI list. The casing uses the settings in the LocaleDisplayNames instance.comparator
- how to sort the UiListItems in the result.- Returns:
- an ordered list of UiListItems.
- Throws:
IllformedLocaleException
- if any of the locales in localeSet are malformed.
-