org.javamoney.moneta.spi

Class AbstractCurrencyConversion

java.lang.Object

org.javamoney.moneta.spi.AbstractCurrencyConversion

All Implemented Interfaces:

java.util.function.Function<javax.money.MonetaryAmount,javax.money.MonetaryAmount>, java.util.function.UnaryOperator<javax.money.MonetaryAmount>, javax.money.convert.CurrencyConversion, javax.money.CurrencySupplier, javax.money.MonetaryOperator

Direct Known Subclasses:

LazyBoundCurrencyConversion

public abstract class AbstractCurrencyConversion
extends Object
implements javax.money.convert.CurrencyConversion

Abstract base class used for implementing currency conversion.

Author:

Anatole Tresch, Werner Keil

Constructor Summary

Constructors

Constructor and Description
AbstractCurrencyConversion(javax.money.CurrencyUnit termCurrency, javax.money.convert.ConversionContext conversionContext)

Method Summary

Modifier and Type	Method and Description
javax.money.MonetaryAmount	apply(javax.money.MonetaryAmount amount) Method that converts the source MonetaryAmount to an MonetaryAmount based on the ExchangeRate of this conversion.
javax.money.convert.ConversionContext	getConversionContext() Access the target ConversionContext of this conversion instance.
javax.money.CurrencyUnit	getCurrency() Access the terminating CurrencyUnit of this conversion instance.
abstract javax.money.convert.ExchangeRate	getExchangeRate(javax.money.MonetaryAmount amount) Get the exchange rate type that this MonetaryOperator instance is using for conversion.
String	toString()
abstract javax.money.convert.CurrencyConversion	with(javax.money.convert.ConversionContext conversionContext)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.UnaryOperator

identity

Methods inherited from interface java.util.function.Function

andThen, compose

Constructor Detail

AbstractCurrencyConversion

public AbstractCurrencyConversion(javax.money.CurrencyUnit termCurrency,
                                  javax.money.convert.ConversionContext conversionContext)

Method Detail

getCurrency

public javax.money.CurrencyUnit getCurrency()

Access the terminating CurrencyUnit of this conversion instance.

Specified by:

getCurrency in interface javax.money.CurrencySupplier

Returns:

the terminating CurrencyUnit , never null.

getConversionContext

public javax.money.convert.ConversionContext getConversionContext()

Access the target ConversionContext of this conversion instance.

Specified by:

getConversionContext in interface javax.money.convert.CurrencyConversion

Returns:

the target ConversionContext.

getExchangeRate

public abstract javax.money.convert.ExchangeRate getExchangeRate(javax.money.MonetaryAmount amount)

Get the exchange rate type that this MonetaryOperator instance is using for conversion.

Specified by:

getExchangeRate in interface javax.money.convert.CurrencyConversion

Returns:

the ExchangeRate to be used, or null, if this conversion is not supported (will lead to a CurrencyConversionException.

See Also:

apply(MonetaryAmount)

with

public abstract javax.money.convert.CurrencyConversion with(javax.money.convert.ConversionContext conversionContext)

apply

public javax.money.MonetaryAmount apply(javax.money.MonetaryAmount amount)

Method that converts the source MonetaryAmount to an MonetaryAmount based on the ExchangeRate of this conversion.

Specified by:

apply in interface java.util.function.Function<javax.money.MonetaryAmount,javax.money.MonetaryAmount>

Parameters:

amount - The source amount

Returns:

The converted amount, never null.

Throws:

javax.money.convert.CurrencyConversionException - if conversion failed, or the required data is not available.

See Also:

getExchangeRate(MonetaryAmount)

toString

public String toString()

Overrides:

toString in class Object