com.ibm.icu.text
Class CurrencyMetaInfo

java.lang.Object
  extended by com.ibm.icu.text.CurrencyMetaInfo

public class CurrencyMetaInfo
extends java.lang.Object

Provides information about currencies that is not specific to a locale.

Status:
Draft ICU 4.4.

Nested Class Summary
static class CurrencyMetaInfo.CurrencyDigits
          Represents the raw information about fraction digits and rounding increment.
static class CurrencyMetaInfo.CurrencyFilter
          A filter used to select which currency info is returned.
static class CurrencyMetaInfo.CurrencyInfo
          Represents a complete currency info record listing the region, currency, from and to dates, and priority.
 
Field Summary
protected static CurrencyMetaInfo.CurrencyDigits defaultDigits
          Deprecated. This API is ICU internal only.
 
Constructor Summary
protected CurrencyMetaInfo()
          Deprecated. This API is ICU internal only.
 
Method Summary
 java.util.List<java.lang.String> currencies(CurrencyMetaInfo.CurrencyFilter filter)
          Returns the list of currency codes matching the provided filter.
 CurrencyMetaInfo.CurrencyDigits currencyDigits(java.lang.String isoCode)
          Returns the CurrencyDigits for the currency code.
 java.util.List<CurrencyMetaInfo.CurrencyInfo> currencyInfo(CurrencyMetaInfo.CurrencyFilter filter)
          Returns the list of CurrencyInfos matching the provided filter.
static CurrencyMetaInfo getInstance()
          Returns the unique instance of the currency meta info.
static boolean hasData()
          Returns true if there is data for the currency meta info.
 java.util.List<java.lang.String> regions(CurrencyMetaInfo.CurrencyFilter filter)
          Returns the list of region codes matching the provided filter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

defaultDigits

protected static final CurrencyMetaInfo.CurrencyDigits defaultDigits
Deprecated. This API is ICU internal only.
Status:
Internal. This API is ICU internal only.
Constructor Detail

CurrencyMetaInfo

protected CurrencyMetaInfo()
Deprecated. This API is ICU internal only.

Subclass constructor.

Status:
Internal. This API is ICU internal only.
Method Detail

getInstance

public static CurrencyMetaInfo getInstance()
Returns the unique instance of the currency meta info.

Returns:
the meta info
Status:
Draft ICU 4.4.

hasData

public static boolean hasData()
Returns true if there is data for the currency meta info.

Returns:
true if there is actual data
Status:
Draft ICU 4.4.

currencyInfo

public java.util.List<CurrencyMetaInfo.CurrencyInfo> currencyInfo(CurrencyMetaInfo.CurrencyFilter filter)
Returns the list of CurrencyInfos matching the provided filter. Results are ordered by country code, then by highest to lowest priority (0 is highest). The returned list is unmodifiable.

Parameters:
filter - the filter to control which currency info to return
Returns:
the matching information
Status:
Draft ICU 4.4.

currencies

public java.util.List<java.lang.String> currencies(CurrencyMetaInfo.CurrencyFilter filter)
Returns the list of currency codes matching the provided filter. Results are ordered as in currencyInfo(CurrencyFilter). The returned list is unmodifiable.

Parameters:
filter - the filter to control which currencies to return. If filter is null, returns all currencies for which information is available.
Returns:
the matching currency codes
Status:
Draft ICU 4.4.

regions

public java.util.List<java.lang.String> regions(CurrencyMetaInfo.CurrencyFilter filter)
Returns the list of region codes matching the provided filter. Results are ordered as in currencyInfo(CurrencyFilter). The returned list is unmodifiable.

Parameters:
filter - the filter to control which regions to return. If filter is null, returns all regions for which information is available.
Returns:
the matching region codes
Status:
Draft ICU 4.4.

currencyDigits

public CurrencyMetaInfo.CurrencyDigits currencyDigits(java.lang.String isoCode)
Returns the CurrencyDigits for the currency code.

Parameters:
isoCode - the currency code
Returns:
the CurrencyDigits
Status:
Draft ICU 4.4.


Copyright (c) 2011 IBM Corporation and others.