org.javamoney.moneta.spi

Class AbstractCurrencyConversion

java.lang.Object

org.javamoney.moneta.spi.AbstractCurrencyConversion

All Implemented Interfaces:

CurrencyConversion, CurrencySupplier, MonetaryOperator

Direct Known Subclasses:

LazyBoundCurrencyConversion

public abstract class AbstractCurrencyConversion
extends Object
implements CurrencyConversion

Abstract base class used for implementing currency conversion.

Author:

Anatole Tresch, Werner Keil

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_SCALE

Constructor Summary

Constructors

Constructor and Description
AbstractCurrencyConversion(CurrencyUnit termCurrency, ConversionContext conversionContext)

Method Summary

Modifier and Type	Method and Description
MonetaryAmount	apply(MonetaryAmount amount) Method that converts the source MonetaryAmount to an MonetaryAmount based on the ExchangeRate of this conversion.
ConversionContext	getContext() Access the target ConversionContext of this conversion instance.
CurrencyUnit	getCurrency() Access the terminating CurrencyUnit of this conversion instance.
abstract ExchangeRate	getExchangeRate(MonetaryAmount amount) Get the exchange rate type that this MonetaryOperator instance is using for conversion.
protected NumberValue	roundFactor(MonetaryAmount amount, NumberValue factor) Optionally rounds the factor to be used.
String	toString()
abstract CurrencyConversion	with(ConversionContext conversionContext)

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.money.convert.CurrencyConversion

getExchangeRateProvider

Field Detail

KEY_SCALE

public static final String KEY_SCALE

See Also:

Constant Field Values

Constructor Detail

AbstractCurrencyConversion

public AbstractCurrencyConversion(CurrencyUnit termCurrency,
                                  ConversionContext conversionContext)

Method Detail

getCurrency

public CurrencyUnit getCurrency()

Access the terminating CurrencyUnit of this conversion instance.

Specified by:

getCurrency in interface CurrencySupplier

Returns:

the terminating CurrencyUnit , never null.

getContext

public ConversionContext getContext()

Access the target ConversionContext of this conversion instance.

Specified by:

getContext in interface CurrencyConversion

Returns:

the target ConversionContext.

getExchangeRate

public abstract ExchangeRate getExchangeRate(MonetaryAmount amount)

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

Specified by:

getExchangeRate in interface 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 CurrencyConversion with(ConversionContext conversionContext)

apply

public MonetaryAmount apply(MonetaryAmount amount)

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

Specified by:

apply in interface MonetaryOperator

Parameters:

amount - The source amount

Returns:

The converted amount, never null.

Throws:

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

See Also:

getExchangeRate(MonetaryAmount)

roundFactor

protected NumberValue roundFactor(MonetaryAmount amount,
                                  NumberValue factor)

Optionally rounds the factor to be used. By default this method will only round as much as it is needed, so the factor can be handled by the target amount instance based on its numeric capabilities. Rounding is applied only if amount.getContext().getMaxScale() > 0 as follows:

• If the amount provides a MathContext as context property this is used.
• If the amount provides a RoundingMode, this is used (default is RoundingMode.HALF_EVEN).
• By default the scale used is scale of the conversion factor. If the acmount allows a higher scale based on amount.getContext().getMaxScale(), this higher scale is used.

Parameters:

amount - the amount, not null.

factor - the factor

Returns:

the new NumberValue, never null.

toString

public String toString()

Overrides:

toString in class Object