org.javamoney.moneta.spi.base

Class BaseMonetaryConversionsSingletonSpi

java.lang.Object

org.javamoney.moneta.spi.base.BaseMonetaryConversionsSingletonSpi

All Implemented Interfaces:

MonetaryConversionsSingletonSpi

Direct Known Subclasses:

DefaultMonetaryConversionsSingletonSpi

public abstract class BaseMonetaryConversionsSingletonSpi
extends Object
implements MonetaryConversionsSingletonSpi

SPI (conversion) that implements the functionality provided by the MonetaryConversions singleton accessor. It should be registered as a service using the JDK ServiceLoader. Hereby only one instance can be registered at a time. This interface is designed to support also contextual behaviour, e.g. in Java EE containers each application may provide its own ExchangeRateProvider instances, e.g. by registering them as CDI beans. An EE container can register an according BaseMonetaryConversionsSingletonSpi that manages the different application contexts transparently. In a SE environment this class is expected to behave like an ordinary singleton, loading its SPIs from the ServiceLoader. Instances of this class must be thread safe. It is not a requirement that they are serializable. Only one instance can be registered using the ServiceLoader. When registering multiple instances the MonetaryConversions accessor will not work.

Author:

Anatole Tresch, Werner Keil

Constructor Summary

Constructors

Constructor and Description
BaseMonetaryConversionsSingletonSpi()

Method Summary

Modifier and Type	Method and Description
CurrencyConversion	getConversion(ConversionQuery conversionQuery) Access an instance of CurrencyConversion.
CurrencyConversion	getConversion(CurrencyUnit termCurrency, String... providers) Access an instance of CurrencyConversion.
ExchangeRateProvider	getExchangeRateProvider(String... providers) Access a compound instance of an ExchangeRateProvider based on the given provider chain.
List<ExchangeRateProvider>	getExchangeRateProviders(String... providers) Access the current registered ExchangeRateProvider instances.
boolean	isConversionAvailable(ConversionQuery conversionQuery) Allows to quickly check, if a CurrencyConversion is accessible for the given ConversionQuery.
boolean	isConversionAvailable(CurrencyUnit termCurrency, String... providers) Allows to quickly check, if a CurrencyConversion is accessible for the given ConversionQuery.
boolean	isExchangeRateProviderAvailable(ConversionQuery conversionQuery) Allows to quickly check, if a ExchangeRateProvider is accessible for the given ConversionQuery.

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.MonetaryConversionsSingletonSpi

getDefaultProviderChain, getExchangeRateProvider, getProviderNames

Constructor Detail

BaseMonetaryConversionsSingletonSpi

public BaseMonetaryConversionsSingletonSpi()

Method Detail

isExchangeRateProviderAvailable

public boolean isExchangeRateProviderAvailable(ConversionQuery conversionQuery)

Allows to quickly check, if a ExchangeRateProvider is accessible for the given ConversionQuery.

Specified by:

isExchangeRateProviderAvailable in interface MonetaryConversionsSingletonSpi

Parameters:

conversionQuery - the ConversionQuery determining the type of conversion required, not null.

Returns:

true, if such a conversion is supported, meaning an according ExchangeRateProvider can be accessed.

See Also:

MonetaryConversionsSingletonSpi.getExchangeRateProvider(javax.money.convert.ConversionQuery), getExchangeRateProvider(String...)}

isConversionAvailable

public boolean isConversionAvailable(ConversionQuery conversionQuery)

Allows to quickly check, if a CurrencyConversion is accessible for the given ConversionQuery.

Specified by:

isConversionAvailable in interface MonetaryConversionsSingletonSpi

Parameters:

conversionQuery - the ConversionQuery determining the type of conversion required, not null.

Returns:

true, if such a conversion is supported, meaning an according CurrencyConversion can be accessed.

See Also:

getConversion(javax.money.convert.ConversionQuery), getConversion(javax.money.CurrencyUnit, String...)}

isConversionAvailable

public boolean isConversionAvailable(CurrencyUnit termCurrency,
                                     String... providers)

Allows to quickly check, if a CurrencyConversion is accessible for the given ConversionQuery.

Specified by:

isConversionAvailable in interface MonetaryConversionsSingletonSpi

Parameters:

termCurrency - the terminating/target currency unit, not null.

providers - the provider names defines a corresponding provider chain that must be encapsulated by the resulting .money.convert.CurrencyConversion. By default the provider chain as defined by #getDefaultRoundingProviderChain will be used.

Returns:

true, if such a conversion is supported, meaning an according CurrencyConversion can be accessed.

See Also:

getConversion(javax.money.convert.ConversionQuery), getConversion(javax.money.CurrencyUnit, String...)}

getExchangeRateProviders

public List<ExchangeRateProvider> getExchangeRateProviders(String... providers)

Access the current registered ExchangeRateProvider instances. If no provider names are passed ALL current registered providers are returned in undefined order.

Specified by:

getExchangeRateProviders in interface MonetaryConversionsSingletonSpi

Parameters:

providers - the provider names of hte providers to be accessed

Returns:

the list of providers, in the same order as requested.

Throws:

MonetaryException - if a provider could not be resolved.

getExchangeRateProvider

public ExchangeRateProvider getExchangeRateProvider(String... providers)

Access a compound instance of an ExchangeRateProvider based on the given provider chain.

Specified by:

getExchangeRateProvider in interface MonetaryConversionsSingletonSpi

Parameters:

providers - the ConversionQuery provider names defines a corresponding provider chain that must be encapsulated by the resulting ExchangeRateProvider. By default the default provider changes as defined in #getDefaultRoundingProviderChain will be used.

Returns:

an ExchangeRateProvider built up with the given sub providers, never null.

Throws:

MonetaryException - if a provider listed could not be found.

See Also:

MonetaryConversionsSingletonSpi.getProviderNames(), isExchangeRateProviderAvailable(javax.money.convert.ConversionQuery)

getConversion

public CurrencyConversion getConversion(ConversionQuery conversionQuery)

Access an instance of CurrencyConversion.

Specified by:

getConversion in interface MonetaryConversionsSingletonSpi

Parameters:

conversionQuery - the ConversionQuery determining the type of conversion required, not null.

Returns:

the corresponding conversion, not null.

Throws:

MonetaryException - if no matching conversion could be found.

See Also:

isConversionAvailable(javax.money.convert.ConversionQuery)

getConversion

public CurrencyConversion getConversion(CurrencyUnit termCurrency,
                                        String... providers)

Access an instance of CurrencyConversion.

Specified by:

getConversion in interface MonetaryConversionsSingletonSpi

Parameters:

termCurrency - the terminating/target currency unit, not null.

providers - the ConversionQuery provider names defines a corresponding provider chain that must be encapsulated by the resulting .money.convert.CurrencyConversion. By default the default provider chain as defined by #getDefaultRoundingProviderChain will be used.

Returns:

the corresponding conversion, not null.

Throws:

MonetaryException - if no matching conversion could be found.

See Also:

isConversionAvailable(javax.money.convert.ConversionQuery)