net.objectlab.kit.fxcalc

Interface CurrencyAmount

All Known Implementing Classes:

Cash

public interface CurrencyAmount

Read-only representation of a currency and a value. Hesitated creating this but it may be better to be explicit when doing conversions with the FX Rate.

Author:

Benoit Xhenseval

Method Summary

Modifier and Type	Method and Description
CurrencyAmount	add(CurrencyAmount money) Add the amount with the existing one and return a MonetaryAmount (implementation could make it immutable and return a new entity)
BigDecimal	getAmount()
String	getCurrency()
CurrencyAmount	negate() Swap the sign on the amount and return a MonetaryAmount (implementation could make it immutable and return a new entity)
CurrencyAmount	subtract(CurrencyAmount money) Subtract the amount from the existing one and return a MonetaryAmount (implementation could make it immutable and return a new entity)

Method Detail

getCurrency

String getCurrency()

getAmount

BigDecimal getAmount()

negate

CurrencyAmount negate()

Swap the sign on the amount and return a MonetaryAmount (implementation could make it immutable and return a new entity)

add

CurrencyAmount add(CurrencyAmount money)

Add the amount with the existing one and return a MonetaryAmount (implementation could make it immutable and return a new entity)

Throws:

IllegalArgumentException - if the money.currency does not match the current one.

subtract

CurrencyAmount subtract(CurrencyAmount money)

Subtract the amount from the existing one and return a MonetaryAmount (implementation could make it immutable and return a new entity)

Throws:

IllegalArgumentException - if the money.currency does not match the current one.