Holger's Java API

## Uses of Class
com.antelmann.math.Money

Packages that use Money
com.antelmann.math: This package contains classes to ease calculations.

Uses of Money in com.antelmann.math

Fields in com.antelmann.math declared as Money
`static Money` `Money.NO_MONEY` a convenient instance that equals new Money(BigDecimal.ZERO).

Methods in com.antelmann.math that return Money
`Money` `Money.abs()` returns Money with an absolute (non-negative) value
`Money` `Money.add(BigDecimal bd)`
`Money` `Money.add(double d)`
`Money` `Money.add(Money m)`
`Money` `Money.add(Number n)`
`Money` `MoneyConverter.convert(Measurable m, Unit targetUnit)`
`Money` `MoneyConverter.convert(Money m)` converts to the base currency
`Money` `MoneyConverter.convertBack(Money obj)` always throws UnsupportedOperationException as it is not clear what currency is desired
`Money` `Money.convertTo(Currency c, BigDecimal exchangeRate)` the given exchangeRage is multiplied with the value
`Money` `Money.convertTo(Currency c, double exchangeRate)` the given exchangeRage is multiplied with the value
`Money` `MoneyConverter.convertToBaseCurrency(Money m)`
`Money` `MoneyConverter.convertToCurrency(Money m, Currency c)`
`Money` `Money.divide(double divisor)`
`Money` `Money.divide(Money divisor)`
`Money` `Money.divide(Number divisor)`
`static Money` `Money.getSmallestPositiveAmountFor(Currency cur)`
`Money` `Money.multiply(double factor)`
`Money` `Money.multiply(long factor)`
`Money` `Money.multiply(Money m)`
`Money` `Money.multiply(Number factor)`
`Money` `Money.negate()`
`Money` `Money.roundToScale(Number scale)`
`Money` `Money.subtract(double d)`
`Money` `Money.subtract(Money m)`
`Money` `Money.subtract(Number b)`

Methods in com.antelmann.math that return types with arguments of type Money

`

`<P,T> HashMap<P,Money>`

`

`MoneyConverter.aggregate(Map<T,Money> data, PatternExtractor<T,P> pattern)`
all Money is converted into the base currency

`static

`<P,T> HashMap<P,Money>`

`

`Money.aggregate(Map<T,Money> data, PatternExtractor<T,P> pattern)`
utility function

Methods in com.antelmann.math with parameters of type Money
`Money` `Money.add(Money m)`
`int` `MoneyConverter.compare(Money m1, Money m2)` If the currencies are not equal, they are compared based on the baseCurrency.
`int` `Money.compareTo(Money m)` only compares value of the same currency
`Money` `MoneyConverter.convert(Money m)` converts to the base currency
`Money` `MoneyConverter.convertBack(Money obj)` always throws UnsupportedOperationException as it is not clear what currency is desired
`Money` `MoneyConverter.convertToBaseCurrency(Money m)`
`Money` `MoneyConverter.convertToCurrency(Money m, Currency c)`
`Money` `Money.divide(Money divisor)`
`BigDecimal` `MoneyConverter.getExchangeRate(Money m)`
`boolean` `Money.isCompatibleTo(Money money)` returns true only if the currency is the same or either money value is zero.
`Money` `Money.multiply(Money m)`
`Money` `Money.subtract(Money m)`

Method parameters in com.antelmann.math with type arguments of type Money

`

`<P,T> HashMap<P,Money>`

`

`MoneyConverter.aggregate(Map<T,Money> data, PatternExtractor<T,P> pattern)`
all Money is converted into the base currency

`static

`<P,T> HashMap<P,Money>`

`

`Money.aggregate(Map<T,Money> data, PatternExtractor<T,P> pattern)`
utility function

(c) Holger Antelmann since 2001- all rights reserved (contact: info@antelmann.com)
see www.antelmann.com/developer for further details and available downloads