org.javamoney.moneta.spi.base

Class BaseExchangeRateProvider

java.lang.Object

org.javamoney.moneta.spi.base.BaseExchangeRateProvider

All Implemented Interfaces:

ExchangeRateProvider

Direct Known Subclasses:

AbstractRateProvider

public abstract class BaseExchangeRateProvider
extends Object
implements ExchangeRateProvider

This interface defines access to the exchange rates provided by a provider. The provider and its capabilities can be defined in arbitrary detail by the corresponding ProviderContext. Instances of this class must only provide conversion data for exact one provider, identified by AbstractContext.getProviderName(). When accessing ExchangeRateProvider instances or CurrencyConversion instances from the MonetaryConversions in many cases a chain of providers will be returned. It is the responsibility of the implementation code assembling the chain to establish a well defined coordination mechanism for evaluating the correct result. By default the first provider in the chain that returns a non null result determines the final result of a call. Nevertheless adapting the MonetaryConversionsSingletonSpi allows to implement also alternate strategies, e.g. honoring different priorities of providers as well. Implementations of this interface are required to be thread save. Implementations of this class must neither be immutable nor serializable.

Author:

Anatole Tresch, Werner Keil

Constructor Summary

Constructors

Constructor and Description
BaseExchangeRateProvider()

Method Summary

Modifier and Type	Method and Description
CurrencyConversion	getCurrencyConversion(CurrencyUnit term) Access a CurrencyConversion that can be applied as a MonetaryOperator to an amount.
CurrencyConversion	getCurrencyConversion(String termCode) Access a CurrencyConversion that can be applied as a MonetaryOperator to an amount.
ExchangeRate	getExchangeRate(CurrencyUnit base, CurrencyUnit term) Access a ExchangeRate using the given currencies.
ExchangeRate	getExchangeRate(String baseCode, String termCode) Access a ExchangeRate using the given currencies.
ExchangeRate	getReversed(ExchangeRate rate) The method reverses the ExchangeRate to a rate mapping from term to base CurrencyUnit.
boolean	isAvailable(ConversionQuery conversionQuery) Checks if an ExchangeRate between two CurrencyUnit is available from this provider.
boolean	isAvailable(CurrencyUnit base, CurrencyUnit term) Checks if an ExchangeRate between two CurrencyUnit is available from this provider.
boolean	isAvailable(String baseCode, String termCode) Checks if an ExchangeRate between two CurrencyUnit is available from this provider.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.money.convert.ExchangeRateProvider

getContext, getCurrencyConversion, getExchangeRate

Constructor Detail

BaseExchangeRateProvider

public BaseExchangeRateProvider()

Method Detail

isAvailable

public boolean isAvailable(ConversionQuery conversionQuery)

Checks if an ExchangeRate between two CurrencyUnit is available from this provider. This method should check, if a given rate is currently defined.

Specified by:

isAvailable in interface ExchangeRateProvider

Parameters:

conversionQuery - the required ConversionQuery, not null

Returns:

true, if such an ExchangeRate is currently defined.

getExchangeRate

public ExchangeRate getExchangeRate(CurrencyUnit base,
                                    CurrencyUnit term)

Access a ExchangeRate using the given currencies. The ExchangeRate may be, depending on the data provider, eal-time or deferred. This method should return the rate that is currently valid.

Specified by:

getExchangeRate in interface ExchangeRateProvider

Parameters:

base - base CurrencyUnit, not null

term - term CurrencyUnit, not null

Throws:

CurrencyConversionException - If no such rate is available.

getCurrencyConversion

public CurrencyConversion getCurrencyConversion(CurrencyUnit term)

Access a CurrencyConversion that can be applied as a MonetaryOperator to an amount.

Specified by:

getCurrencyConversion in interface ExchangeRateProvider

Parameters:

term - term CurrencyUnit, not null

Returns:

a new instance of a corresponding CurrencyConversion, never null.

isAvailable

public boolean isAvailable(CurrencyUnit base,
                           CurrencyUnit term)

Checks if an ExchangeRate between two CurrencyUnit is available from this provider. This method should check, if a given rate is currently defined.

Specified by:

isAvailable in interface ExchangeRateProvider

Parameters:

base - the base CurrencyUnit

term - the term CurrencyUnit

Returns:

true, if such an ExchangeRate is currently defined.

isAvailable

public boolean isAvailable(String baseCode,
                           String termCode)

Checks if an ExchangeRate between two CurrencyUnit is available from this provider. This method should check, if a given rate is currently defined.

Specified by:

isAvailable in interface ExchangeRateProvider

Parameters:

baseCode - the base currency code

termCode - the terminal/target currency code

Returns:

true, if such an ExchangeRate is currently defined.

Throws:

MonetaryException - if one of the currency codes passed is not valid.

getExchangeRate

public ExchangeRate getExchangeRate(String baseCode,
                                    String termCode)

Access a ExchangeRate using the given currencies. The ExchangeRate may be, depending on the data provider, eal-time or deferred. This method should return the rate that is currently valid.

Specified by:

getExchangeRate in interface ExchangeRateProvider

Parameters:

baseCode - base currency code, not null

termCode - term/target currency code, not null

Returns:

the matching ExchangeRate.

Throws:

CurrencyConversionException - If no such rate is available.

MonetaryException - if one of the currency codes passed is not valid.

getReversed

public ExchangeRate getReversed(ExchangeRate rate)

The method reverses the ExchangeRate to a rate mapping from term to base CurrencyUnit. Hereby the factor must not be recalculated as 1/oldFactor, since typically reverse rates are not symmetric in most cases.

Specified by:

getReversed in interface ExchangeRateProvider

Returns:

the matching reversed ExchangeRate, or null, if the rate cannot be reversed.

getCurrencyConversion

public CurrencyConversion getCurrencyConversion(String termCode)

Access a CurrencyConversion that can be applied as a MonetaryOperator to an amount.

Specified by:

getCurrencyConversion in interface ExchangeRateProvider

Parameters:

termCode - terminal/target currency code, not null

Returns:

a new instance of a corresponding CurrencyConversion, never null.

Throws:

MonetaryException - if one of the currency codes passed is not valid.