Class CurrencyDisplayNames
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Deprecated.This API is ICU internal only. -
Method Summary
Modifier and TypeMethodDescriptionabstract String
getFormalSymbol
(String isoCode) Returns the formal symbol for the currency with the provided ISO code.static CurrencyDisplayNames
getInstance
(ULocale locale) Return an instance of CurrencyDisplayNames that provides information localized for display in the provided locale.static CurrencyDisplayNames
getInstance
(ULocale locale, boolean noSubstitute) Return an instance of CurrencyDisplayNames that provides information localized for display in the provided locale.static CurrencyDisplayNames
getInstance
(Locale locale) Return an instance of CurrencyDisplayNames that provides information localized for display in the provided locale.static CurrencyDisplayNames
getInstance
(Locale locale, boolean noSubstitute) Return an instance of CurrencyDisplayNames that provides information localized for display in the provided locale.abstract String
Returns the 'long name' for the currency with the provided ISO code.abstract String
getNarrowSymbol
(String isoCode) Returns the narrow symbol for the currency with the provided ISO code.abstract String
getPluralName
(String isoCode, String pluralKey) Returns a 'plural name' for the currency with the provided ISO code corresponding to the pluralKey.abstract String
Returns the symbol for the currency with the provided ISO code.abstract ULocale
Returns the locale used to determine how to translate the currency names.abstract String
getVariantSymbol
(String isoCode) Returns the variant symbol for the currency with the provided ISO code.static boolean
hasData()
Deprecated.This API is ICU internal only.nameMap()
Returns a mapping from localized names (standard and plural) to currency codes.Returns a mapping from localized symbols and currency codes to currency codes.
-
Constructor Details
-
CurrencyDisplayNames
Deprecated.This API is ICU internal only.Sole constructor. (For invocation by subclass constructors, typically implicit.)
-
-
Method Details
-
getInstance
Return an instance of CurrencyDisplayNames that provides information localized for display in the provided locale. If there is no data for the provided locale, this falls back to the current default locale; if there is no data for that either, it falls back to the root locale. Substitute values are returned from APIs when there is no data for the requested ISO code.- Parameters:
locale
- the locale into which to localize the names- Returns:
- a CurrencyDisplayNames
-
getInstance
Return an instance of CurrencyDisplayNames that provides information localized for display in the provided locale. If there is no data for the provided locale, this falls back to the current default locale; if there is no data for that either, it falls back to the root locale. Substitute values are returned from APIs when there is no data for the requested ISO code.- Parameters:
locale
- the locale into which to localize the names- Returns:
- a CurrencyDisplayNames
-
getInstance
Return an instance of CurrencyDisplayNames that provides information localized for display in the provided locale. If noSubstitute is false, this behaves likegetInstance(ULocale)
. Otherwise, 1) if there is no supporting data for the locale at all, there is no fallback through the default locale or root, and null is returned, and 2) if there is data for the locale, but not data for the requested ISO code, null is returned from those APIs instead of a substitute value.- Parameters:
locale
- the locale into which to localize the namesnoSubstitute
- if true, do not return substitute values.- Returns:
- a CurrencyDisplayNames
-
getInstance
Return an instance of CurrencyDisplayNames that provides information localized for display in the provided locale. If noSubstitute is false, this behaves likegetInstance(Locale)
. Otherwise, 1) if there is no supporting data for the locale at all, there is no fallback through the default locale or root, and null is returned, and 2) if there is data for the locale, but not data for the requested ISO code, null is returned from those APIs instead of a substitute value.- Parameters:
locale
- theLocale
into which to localize the namesnoSubstitute
- if true, do not return substitute values.- Returns:
- a CurrencyDisplayNames
-
hasData
Deprecated.This API is ICU internal only.Returns true if currency display name data is available.- Returns:
- true if currency display name data is available
-
getULocale
Returns the locale used to determine how to translate the currency names. This is not necessarily the same locale passed togetInstance(ULocale)
.- Returns:
- the display locale
-
getSymbol
Returns the symbol for the currency with the provided ISO code.If there is no data for this symbol, substitutes isoCode, or returns null if noSubstitute was set in the factory method.
- Parameters:
isoCode
- the three-letter ISO code.- Returns:
- the symbol.
-
getNarrowSymbol
Returns the narrow symbol for the currency with the provided ISO code.The narrow currency symbol is similar to the regular currency symbol, but it always takes the shortest form; for example, "$" instead of "US$" for USD in en-CA.
If there is no data for this symbol, substitutes the default symbol, or returns null if noSubstitute was set in the factory method.
- Parameters:
isoCode
- the three-letter ISO code.- Returns:
- the narrow symbol.
-
getFormalSymbol
Returns the formal symbol for the currency with the provided ISO code.The formal currency symbol is similar to the regular currency symbol, but it always takes the form used in formal settings such as banking; for example, "NT$" instead of "$" for TWD in zh-TW.
If there is no data for this symbol, substitutes the default symbol, or returns null if noSubstitute was set in the factory method.
- Parameters:
isoCode
- the three-letter ISO code.- Returns:
- the formal symbol.
-
getVariantSymbol
Returns the variant symbol for the currency with the provided ISO code.The variant symbol for a currency is an alternative symbol that is not necessarily as widely used as the regular symbol.
If there is no data for variant symbol, substitutes the default symbol, or returns null if noSubstitute was set in the factory method.
- Parameters:
isoCode
- the three-letter ISO code.- Returns:
- the variant symbol.
-
getName
Returns the 'long name' for the currency with the provided ISO code. If there is no data for the ISO code, substitutes isoCode, or returns null if noSubstitute was set in the factory method.- Parameters:
isoCode
- the three-letter ISO code- Returns:
- the display name
-
getPluralName
Returns a 'plural name' for the currency with the provided ISO code corresponding to the pluralKey. If there is no data for the ISO code, substitutes isoCode or returns null. If there is data for the ISO code but no data for the plural key, substitutes the 'other' value (and failing that the isoCode) or returns null.- Parameters:
isoCode
- the three-letter ISO codepluralKey
- the plural key, for example "one", "other"- Returns:
- the display name
- See Also:
-
symbolMap
Returns a mapping from localized symbols and currency codes to currency codes. The returned map is unmodifiable.- Returns:
- the map
-
nameMap
Returns a mapping from localized names (standard and plural) to currency codes. The returned map is unmodifiable.- Returns:
- the map
-