org.javamoney.moneta.spi.base

Class BaseMonetaryCurrenciesSingletonSpi

java.lang.Object

org.javamoney.moneta.spi.base.BaseMonetaryCurrenciesSingletonSpi

All Implemented Interfaces:

MonetaryCurrenciesSingletonSpi

Direct Known Subclasses:

DefaultMonetaryCurrenciesSingletonSpi

public abstract class BaseMonetaryCurrenciesSingletonSpi
extends Object
implements MonetaryCurrenciesSingletonSpi

Factory singleton backing interface for Monetary that provides access to different registered CurrencyProviderSpi instances. Implementations of this interface must be thread safe.

Version:

0.8

Author:

Anatole Tresch

Constructor Summary

Constructors

Constructor and Description
BaseMonetaryCurrenciesSingletonSpi()

Method Summary

Modifier and Type	Method and Description
Set<CurrencyUnit>	getCurrencies(Locale locale, String... providers) Provide access to all currently known currencies.
Set<CurrencyUnit>	getCurrencies(String... providers) Provide access to all currently known currencies.
CurrencyUnit	getCurrency(CurrencyQuery query) Access a single currency by query.
CurrencyUnit	getCurrency(Locale country, String... providers) Access a new instance based on the currency code.
CurrencyUnit	getCurrency(String currencyCode, String... providers) Access a new instance based on the currency code.
boolean	isCurrencyAvailable(Locale locale, String... providers) Allows to check if a CurrencyUnit instance is defined, i.e.
boolean	isCurrencyAvailable(String code, String... providers) Allows to check if a CurrencyUnit instance is defined, i.e.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.money.spi.MonetaryCurrenciesSingletonSpi

getCurrencies, getDefaultProviderChain, getProviderNames

Constructor Detail

BaseMonetaryCurrenciesSingletonSpi

public BaseMonetaryCurrenciesSingletonSpi()

Method Detail

getCurrency

public CurrencyUnit getCurrency(String currencyCode,
                                String... providers)

Access a new instance based on the currency code. Currencies are available as provided by CurrencyProviderSpi instances registered with the Bootstrap.

Specified by:

getCurrency in interface MonetaryCurrenciesSingletonSpi

Parameters:

currencyCode - the ISO currency code, not null.

providers - the (optional) specification of providers to consider. If not set (empty) the providers as defined by #getDefaultRoundingProviderChain() should be used.

Returns:

the corresponding CurrencyUnit instance.

Throws:

UnknownCurrencyException - if no such currency exists.

getCurrency

public CurrencyUnit getCurrency(Locale country,
                                String... providers)

Access a new instance based on the currency code. Currencies are available as provided by CurrencyProviderSpi instances registered with the Bootstrap.

Specified by:

getCurrency in interface MonetaryCurrenciesSingletonSpi

Parameters:

country - the ISO currency's country, not null.

providers - the (optional) specification of providers to consider. If not set (empty) the providers as defined by #getDefaultRoundingProviderChain() should be used.

Returns:

the corresponding CurrencyUnit instance.

Throws:

UnknownCurrencyException - if no such currency exists.

getCurrencies

public Set<CurrencyUnit> getCurrencies(Locale locale,
                                       String... providers)

Provide access to all currently known currencies.

Specified by:

getCurrencies in interface MonetaryCurrenciesSingletonSpi

Parameters:

locale - the target Locale, typically representing an ISO country, not null.

providers - the (optional) specification of providers to consider. If not set (empty) the providers as defined by #getDefaultRoundingProviderChain() should be used.

Returns:

a collection of all known currencies, never null.

isCurrencyAvailable

public boolean isCurrencyAvailable(String code,
                                   String... providers)

Allows to check if a CurrencyUnit instance is defined, i.e. accessible from getCurrency(String, String...).

Specified by:

isCurrencyAvailable in interface MonetaryCurrenciesSingletonSpi

Parameters:

code - the currency code, not null.

providers - the (optional) specification of providers to consider. If not set (empty) the providers as defined by #getDefaultRoundingProviderChain() should be used.

Returns:

true if getCurrency(String, String...) would return a result for the given code.

isCurrencyAvailable

public boolean isCurrencyAvailable(Locale locale,
                                   String... providers)

Allows to check if a CurrencyUnit instance is defined, i.e. accessible from getCurrency(String, String...).

Specified by:

isCurrencyAvailable in interface MonetaryCurrenciesSingletonSpi

Parameters:

locale - the target Locale, not null.

providers - the (optional) specification of providers to consider. If not set (empty) the providers as defined by #getDefaultRoundingProviderChain() should be used.

Returns:

true if getCurrencies(java.util.Locale, String...) would return a non empty result for the given code.

getCurrencies

public Set<CurrencyUnit> getCurrencies(String... providers)

Provide access to all currently known currencies.

Specified by:

getCurrencies in interface MonetaryCurrenciesSingletonSpi

Parameters:

providers - the (optional) specification of providers to consider. If not set (empty) the providers as defined by #getDefaultRoundingProviderChain() should be used.

Returns:

a collection of all known currencies, never null.

getCurrency

public CurrencyUnit getCurrency(CurrencyQuery query)

Access a single currency by query.

Specified by:

getCurrency in interface MonetaryCurrenciesSingletonSpi

Parameters:

query - The currency query, not null.

Returns:

the CurrencyUnit found, never null.

Throws:

MonetaryException - if multiple currencies match the query.