org.javamoney.moneta.convert

Class IdentityRateProvider

java.lang.Object

org.javamoney.moneta.spi.base.BaseExchangeRateProvider

org.javamoney.moneta.spi.AbstractRateProvider

org.javamoney.moneta.convert.IdentityRateProvider

All Implemented Interfaces:

ExchangeRateProvider

public class IdentityRateProvider
extends AbstractRateProvider

This class implements an ExchangeRateProvider that provides exchange rate with factor one for identical base/term currencies.

Author:

Anatole Tresch, Werner Keil

Field Summary

Fields inherited from class org.javamoney.moneta.spi.AbstractRateProvider

LOGGER

Constructor Summary

Constructors

Constructor and Description
IdentityRateProvider() Constructor, also loads initial data.

Method Summary

Modifier and Type	Method and Description
ExchangeRate	getExchangeRate(ConversionQuery query)
ExchangeRate	getReversed(ExchangeRate rate) The method reverses the ExchangeRate to a rate mapping from term to base CurrencyUnit.
boolean	isAvailable(ConversionQuery conversionQuery) Check if this provider can provide a rate, which is only the case if base and term are equal.

Methods inherited from class org.javamoney.moneta.spi.AbstractRateProvider

divide, divide, formatLocalDate, getContext, getCurrencyConversion, multiply

Methods inherited from class org.javamoney.moneta.spi.base.BaseExchangeRateProvider

getCurrencyConversion, getCurrencyConversion, getExchangeRate, getExchangeRate, isAvailable, isAvailable

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityRateProvider

public IdentityRateProvider()

Constructor, also loads initial data.

Method Detail

isAvailable

public boolean isAvailable(ConversionQuery conversionQuery)

Check if this provider can provide a rate, which is only the case if base and term are equal.

Specified by:

isAvailable in interface ExchangeRateProvider

Overrides:

isAvailable in class BaseExchangeRateProvider

Parameters:

conversionQuery - the required ConversionQuery, not null

Returns:

true, if the contained base and term currencies are known to this provider.

getExchangeRate

public ExchangeRate getExchangeRate(ConversionQuery query)

Specified by:

getExchangeRate in interface ExchangeRateProvider

Specified by:

getExchangeRate in class AbstractRateProvider

getReversed

public ExchangeRate getReversed(ExchangeRate rate)

Description copied from class: BaseExchangeRateProvider

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

Overrides:

getReversed in class BaseExchangeRateProvider

Returns:

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