FastMoney (Moneta (JSR 354 RI) 0.8 API)

java.lang.Object
- org.javamoney.moneta.spi.AbstractMoney
- - org.javamoney.moneta.FastMoney

All Implemented Interfaces:

Serializable, Comparable<javax.money.MonetaryAmount>, javax.money.CurrencySupplier, javax.money.MonetaryAmount, javax.money.NumberSupplier
```
public final class FastMoney
extends AbstractMoney
implements Comparable<javax.money.MonetaryAmount>, Serializable
```
long based implementation of MonetaryAmount. This class internally uses a single long number as numeric representation, which basically is interpreted as minor units.
It suggested to have a performance advantage of a 10-15 times faster compared to Money, which internally uses BigDecimal. Nevertheless this comes with a price of less precision. As an example performing the following calculation one million times, results in slightly different results:
```
 Money money1 = money1.add(Money.of(EURO, 1234567.3444));
 money1 = money1.subtract(Money.of(EURO, 232323));
 money1 = money1.multiply(3.4);
 money1 = money1.divide(5.456);
 
```
Executed one million (1000000) times this results in EUR 1657407.962529182, calculated in 3680 ms, or roughly 3ns/loop.
whrereas
```
 FastMoney money1 = money1.add(FastMoney.of(EURO, 1234567.3444));
 money1 = money1.subtract(FastMoney.of(EURO, 232323));
 money1 = money1.multiply(3.4);
 money1 = money1.divide(5.456);
 
```
executed one million (1000000) times results in EUR 1657407.96251, calculated in 179 ms, which is less than 1ns/loop.
Also note than mixing up types my drastically change the performance behavior. E.g. replacing the code above with the following: *
```
 FastMoney money1 = money1.add(Money.of(EURO, 1234567.3444));
 money1 = money1.subtract(FastMoney.of(EURO, 232323));
 money1 = money1.multiply(3.4);
 money1 = money1.divide(5.456);
 
```
executed one million (1000000) times may execute significantly longer, since monetary amount type conversion is involved.
Basically, when mixing amount implementations, the performance of the amount, on which most of the operations are operated, has the most significant impact on the overall performance behavior.
Version:

0.5.2

Author:

Anatole Tresch, Werner Keil

See Also:
Serialized Form

Field Summary
- Fields inherited from class org.javamoney.moneta.spi.AbstractMoney
  currency, monetaryContext

Method Summary

Methods
Modifier and Type	Method and Description
`FastMoney`	`abs()`
`FastMoney`	`add(javax.money.MonetaryAmount amount)`
`int`	`compareTo(javax.money.MonetaryAmount o)`
`FastMoney`	`divide(double number)`
`FastMoney`	`divide(long amount)`
`FastMoney`	`divide(Number divisor)`
`FastMoney[]`	`divideAndRemainder(double amount)`
`FastMoney[]`	`divideAndRemainder(long amount)`
`FastMoney[]`	`divideAndRemainder(Number divisor)`
`FastMoney`	`divideToIntegralValue(double divisor)`
`FastMoney`	`divideToIntegralValue(long divisor)`
`FastMoney`	`divideToIntegralValue(Number divisor)`
`boolean`	`equals(Object obj)`
`static FastMoney`	`from(javax.money.MonetaryAmount amount)`
`javax.money.CurrencyUnit`	`getCurrency()` Returns the amount’s currency, modelled as `CurrencyUnit`.
`protected javax.money.MonetaryContext`	`getDefaultMonetaryContext()` Method to be implemented by superclasses to provide the default `MonetaryContext`, when not explicit `MonetaryContext` is available.
`javax.money.MonetaryAmountFactory<FastMoney>`	`getFactory()`
`javax.money.MonetaryContext`	`getMonetaryContext()` Access the `MonetaryContext` used by this instance.
`javax.money.NumberValue`	`getNumber()` Gets the number representation of the numeric value of this item.
`int`	`getPrecision()`
`int`	`getScale()`
`int`	`hashCode()`
`boolean`	`hasSameNumberAs(Number number)`
`boolean`	`isEqualTo(javax.money.MonetaryAmount amount)`
`boolean`	`isGreaterThan(javax.money.MonetaryAmount amount)`
`boolean`	`isGreaterThan(Number number)`
`boolean`	`isGreaterThanOrEqualTo(javax.money.MonetaryAmount amount)`
`boolean`	`isGreaterThanOrEqualTo(Number number)`
`boolean`	`isLessThan(javax.money.MonetaryAmount amount)`
`boolean`	`isLessThan(Number number)`
`boolean`	`isLessThanOrEqualTo(javax.money.MonetaryAmount amount)`
`boolean`	`isLessThanOrEqualTo(Number number)`
`boolean`	`isNegative()`
`boolean`	`isNegativeOrZero()`
`boolean`	`isNotEqualTo(javax.money.MonetaryAmount amount)`
`boolean`	`isNotEqualTo(Number number)`
`boolean`	`isPositive()`
`boolean`	`isPositiveOrZero()`
`boolean`	`isZero()`
`FastMoney`	`multiply(double amount)`
`FastMoney`	`multiply(long multiplicand)`
`FastMoney`	`multiply(Number multiplicand)`
`FastMoney`	`negate()`
`static FastMoney`	`of(javax.money.CurrencyUnit currency, Number number)` Static factory method for creating a new instance of `FastMoney`.
`static FastMoney`	`of(javax.money.CurrencyUnit currency, javax.money.NumberValue numberBinding)` Static factory method for creating a new instance of `FastMoney`.
`static FastMoney`	`of(String currencyCode, Number number)` Static factory method for creating a new instance of `FastMoney`.
`FastMoney`	`plus()`
`<R> R`	`query(javax.money.MonetaryQuery<R> query)`
`FastMoney`	`remainder(double amount)`
`FastMoney`	`remainder(long number)`
`FastMoney`	`remainder(Number divisor)`
`FastMoney`	`scaleByPowerOfTen(int n)`
`int`	`signum()`
`FastMoney`	`stripTrailingZeros()`
`FastMoney`	`subtract(javax.money.MonetaryAmount subtrahend)`
`String`	`toString()`
`FastMoney`	`with(javax.money.MonetaryOperator operator)`

Methods inherited from class org.javamoney.moneta.spi.AbstractMoney
checkAmountParameter, checkNumberParameter, getBigDecimal, getBigDecimal, getBigDecimal, getBigDecimal, getMathContext

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - of
```
public static FastMoney of(javax.money.CurrencyUnit currency,
           javax.money.NumberValue numberBinding)
```
    Static factory method for creating a new instance of FastMoney.
    
    Parameters:
    currency - The target currency, not null.
    numberBinding - The numeric part, not null.
    
    Returns:
    A new instance of FastMoney.
  - of
```
public static FastMoney of(javax.money.CurrencyUnit currency,
           Number number)
```
    Static factory method for creating a new instance of FastMoney.
    
    Parameters:
    currency - The target currency, not null.
    number - The numeric part, not null.
    
    Returns:
    A new instance of FastMoney.
  - of
```
public static FastMoney of(String currencyCode,
           Number number)
```
    Static factory method for creating a new instance of FastMoney.
    
    Parameters:
    currencyCode - The target currency as currency code.
    number - The numeric part, not null.
    
    Returns:
    A new instance of FastMoney.
  - compareTo
```
public int compareTo(javax.money.MonetaryAmount o)
```
    Specified by:
    
    compareTo in interface Comparable<javax.money.MonetaryAmount>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - getCurrency
```
public javax.money.CurrencyUnit getCurrency()
```
    Description copied from class: AbstractMoney
    
    Returns the amount’s currency, modelled as CurrencyUnit. Implementations may co-variantly change the return type to a more specific implementation of CurrencyUnit if desired.
    
    Specified by:
    
    getCurrency in interface javax.money.CurrencySupplier
    
    Specified by:
    
    getCurrency in interface javax.money.MonetaryAmount
    
    Overrides:
    
    getCurrency in class AbstractMoney
    
    Returns:
    the currency, never null
    See Also:
    MonetaryAmount.getCurrency()
  - abs
```
public FastMoney abs()
```
    Specified by:
    
    abs in interface javax.money.MonetaryAmount
  - add
```
public FastMoney add(javax.money.MonetaryAmount amount)
```
    Specified by:
    
    add in interface javax.money.MonetaryAmount
  - divide
```
public FastMoney divide(Number divisor)
```
    Specified by:
    
    divide in interface javax.money.MonetaryAmount
  - divideAndRemainder
```
public FastMoney[] divideAndRemainder(Number divisor)
```
    Specified by:
    
    divideAndRemainder in interface javax.money.MonetaryAmount
  - divideToIntegralValue
```
public FastMoney divideToIntegralValue(Number divisor)
```
    Specified by:
    
    divideToIntegralValue in interface javax.money.MonetaryAmount
  - multiply
```
public FastMoney multiply(Number multiplicand)
```
    Specified by:
    
    multiply in interface javax.money.MonetaryAmount
  - negate
```
public FastMoney negate()
```
    Specified by:
    
    negate in interface javax.money.MonetaryAmount
  - plus
```
public FastMoney plus()
```
    Specified by:
    
    plus in interface javax.money.MonetaryAmount
  - subtract
```
public FastMoney subtract(javax.money.MonetaryAmount subtrahend)
```
    Specified by:
    
    subtract in interface javax.money.MonetaryAmount
  - remainder
```
public FastMoney remainder(Number divisor)
```
    Specified by:
    
    remainder in interface javax.money.MonetaryAmount
  - scaleByPowerOfTen
```
public FastMoney scaleByPowerOfTen(int n)
```
    Specified by:
    
    scaleByPowerOfTen in interface javax.money.MonetaryAmount
  - isZero
```
public boolean isZero()
```
    Specified by:
    
    isZero in interface javax.money.MonetaryAmount
  - isPositive
```
public boolean isPositive()
```
    Specified by:
    
    isPositive in interface javax.money.MonetaryAmount
  - isPositiveOrZero
```
public boolean isPositiveOrZero()
```
    Specified by:
    
    isPositiveOrZero in interface javax.money.MonetaryAmount
  - isNegative
```
public boolean isNegative()
```
    Specified by:
    
    isNegative in interface javax.money.MonetaryAmount
  - isNegativeOrZero
```
public boolean isNegativeOrZero()
```
    Specified by:
    
    isNegativeOrZero in interface javax.money.MonetaryAmount
  - getScale
```
public int getScale()
```
  - getPrecision
```
public int getPrecision()
```
  - signum
```
public int signum()
```
    Specified by:
    
    signum in interface javax.money.MonetaryAmount
  - isLessThan
```
public boolean isLessThan(javax.money.MonetaryAmount amount)
```
    Specified by:
    
    isLessThan in interface javax.money.MonetaryAmount
  - isLessThan
```
public boolean isLessThan(Number number)
```
  - isLessThanOrEqualTo
```
public boolean isLessThanOrEqualTo(javax.money.MonetaryAmount amount)
```
    Specified by:
    
    isLessThanOrEqualTo in interface javax.money.MonetaryAmount
  - isLessThanOrEqualTo
```
public boolean isLessThanOrEqualTo(Number number)
```
  - isGreaterThan
```
public boolean isGreaterThan(javax.money.MonetaryAmount amount)
```
    Specified by:
    
    isGreaterThan in interface javax.money.MonetaryAmount
  - isGreaterThan
```
public boolean isGreaterThan(Number number)
```
  - isGreaterThanOrEqualTo
```
public boolean isGreaterThanOrEqualTo(javax.money.MonetaryAmount amount)
```
    Specified by:
    
    isGreaterThanOrEqualTo in interface javax.money.MonetaryAmount
  - isGreaterThanOrEqualTo
```
public boolean isGreaterThanOrEqualTo(Number number)
```
  - isEqualTo
```
public boolean isEqualTo(javax.money.MonetaryAmount amount)
```
    Specified by:
    
    isEqualTo in interface javax.money.MonetaryAmount
  - hasSameNumberAs
```
public boolean hasSameNumberAs(Number number)
```
  - isNotEqualTo
```
public boolean isNotEqualTo(javax.money.MonetaryAmount amount)
```
  - isNotEqualTo
```
public boolean isNotEqualTo(Number number)
```
  - getNumber
```
public javax.money.NumberValue getNumber()
```
    Gets the number representation of the numeric value of this item.
    
    Specified by:
    
    getNumber in interface javax.money.MonetaryAmount
    
    Specified by:
    
    getNumber in interface javax.money.NumberSupplier
    
    Returns:
    The Number represention matching best.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - with
```
public FastMoney with(javax.money.MonetaryOperator operator)
```
    Specified by:
    
    with in interface javax.money.MonetaryAmount
  - query
```
public <R> R query(javax.money.MonetaryQuery<R> query)
```
    Specified by:
    
    query in interface javax.money.MonetaryAmount
  - from
```
public static FastMoney from(javax.money.MonetaryAmount amount)
```
  - getMonetaryContext
```
public javax.money.MonetaryContext getMonetaryContext()
```
    Description copied from class: AbstractMoney
    
    Access the MonetaryContext used by this instance.
    
    Specified by:
    
    getMonetaryContext in interface javax.money.MonetaryAmount
    
    Overrides:
    
    getMonetaryContext in class AbstractMoney
    
    Returns:
    the MonetaryContext used, never null.
    See Also:
    MonetaryAmount.getMonetaryContext()
  - multiply
```
public FastMoney multiply(double amount)
```
    Specified by:
    
    multiply in interface javax.money.MonetaryAmount
  - divide
```
public FastMoney divide(long amount)
```
    Specified by:
    
    divide in interface javax.money.MonetaryAmount
  - divide
```
public FastMoney divide(double number)
```
    Specified by:
    
    divide in interface javax.money.MonetaryAmount
  - remainder
```
public FastMoney remainder(long number)
```
    Specified by:
    
    remainder in interface javax.money.MonetaryAmount
  - remainder
```
public FastMoney remainder(double amount)
```
    Specified by:
    
    remainder in interface javax.money.MonetaryAmount
  - divideAndRemainder
```
public FastMoney[] divideAndRemainder(long amount)
```
    Specified by:
    
    divideAndRemainder in interface javax.money.MonetaryAmount
  - divideAndRemainder
```
public FastMoney[] divideAndRemainder(double amount)
```
    Specified by:
    
    divideAndRemainder in interface javax.money.MonetaryAmount
  - stripTrailingZeros
```
public FastMoney stripTrailingZeros()
```
    Specified by:
    
    stripTrailingZeros in interface javax.money.MonetaryAmount
  - multiply
```
public FastMoney multiply(long multiplicand)
```
    Specified by:
    
    multiply in interface javax.money.MonetaryAmount
  - divideToIntegralValue
```
public FastMoney divideToIntegralValue(long divisor)
```
    Specified by:
    
    divideToIntegralValue in interface javax.money.MonetaryAmount
  - divideToIntegralValue
```
public FastMoney divideToIntegralValue(double divisor)
```
    Specified by:
    
    divideToIntegralValue in interface javax.money.MonetaryAmount
  - getDefaultMonetaryContext
```
protected javax.money.MonetaryContext getDefaultMonetaryContext()
```
    Description copied from class: AbstractMoney
    
    Method to be implemented by superclasses to provide the default MonetaryContext, when not explicit MonetaryContext is available.
    
    Specified by:
    
    getDefaultMonetaryContext in class AbstractMoney
    
    Returns:
    the default MonetaryContext, never null.
  - getFactory
```
public javax.money.MonetaryAmountFactory<FastMoney> getFactory()
```
    Specified by:
    
    getFactory in interface javax.money.MonetaryAmount

Class FastMoney

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

of

of

of

compareTo

hashCode

equals

getCurrency

abs

add

divide

divideAndRemainder

divideToIntegralValue

multiply

negate

plus

subtract

remainder

scaleByPowerOfTen

isZero

isPositive

isPositiveOrZero

isNegative

isNegativeOrZero

getScale

getPrecision

signum

isLessThan

isLessThan

isLessThanOrEqualTo

isLessThanOrEqualTo

isGreaterThan

isGreaterThan

isGreaterThanOrEqualTo

isGreaterThanOrEqualTo

isEqualTo

hasSameNumberAs

isNotEqualTo

isNotEqualTo

getNumber

toString

with

query

from

getMonetaryContext

multiply

divide

divide

remainder

remainder

divideAndRemainder

divideAndRemainder

stripTrailingZeros

multiply

divideToIntegralValue

divideToIntegralValue

getDefaultMonetaryContext

getFactory