Money (Moneta (JSR 354 RI) 0.8 API)

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

All Implemented Interfaces:

Serializable, Comparable<javax.money.MonetaryAmount>, javax.money.CurrencySupplier, javax.money.MonetaryAmount, javax.money.NumberSupplier
```
public final class Money
extends AbstractMoney
implements Comparable<javax.money.MonetaryAmount>, Serializable
```
Platform RI: Default immutable implementation of MonetaryAmount based on BigDecimal for the numeric representation.
As required by MonetaryAmount this class is final, thread-safe, immutable and serializable.
This class can be configured with an arbitrary MonetaryContext. The default MonetaryContext used models by default the same settings as MathContext.DECIMAL64 . This default MonetaryContext can also be reconfigured by adding a file /javamoney.properties to the classpath, with the following content:
```
 # Default MathContext for Money
 #-------------------------------
 # Custom MonetaryContext, overrides default entries from
 # org.javamoney.moneta.Money.monetaryContext
 # RoundingMode hereby is optional (default = HALF_EVEN)
 org.javamoney.moneta.Money.defaults.precision=256
 org.javamoney.moneta.Money.defaults.roundingMode=HALF_EVEN
 
```
Version:

0.6.1

Author:

Anatole Tresch, Werner Keil

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static javax.money.MonetaryContext DEFAULT_MONETARY_CONTEXT
The default MonetaryContext applied, if not set explicitly on creation.
- Fields inherited from class org.javamoney.moneta.spi.AbstractMoney
  currency, monetaryContext

Fields
Modifier and Type	Field and Description
`static javax.money.MonetaryContext`	`DEFAULT_MONETARY_CONTEXT` The default `MonetaryContext` applied, if not set explicitly on creation.

Method Summary

Methods
Modifier and Type	Method and Description
`Money`	`abs()`
`Money`	`add(javax.money.MonetaryAmount amount)`
`int`	`compareTo(javax.money.MonetaryAmount o)`
`Money`	`divide(double divisor)`
`Money`	`divide(long divisor)`
`Money`	`divide(Number divisor)`
`Money[]`	`divideAndRemainder(double divisor)`
`Money[]`	`divideAndRemainder(long divisor)`
`Money[]`	`divideAndRemainder(Number divisor)`
`Money`	`divideToIntegralValue(double divisor)`
`Money`	`divideToIntegralValue(long divisor)`
`Money`	`divideToIntegralValue(Number divisor)`
`boolean`	`equals(Object obj)`
`static Money`	`from(javax.money.MonetaryAmount amt)` Converts (if necessary) the given `MonetaryAmount` to a `Money` instance.
`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<Money>`	`getFactory()`
`javax.money.NumberValue`	`getNumber()`
`BigDecimal`	`getNumberStripped()` Method that returns BigDecimal.ZERO, if `isZero()`, and `#stripTrailingZeros()` in all other cases.
`int`	`hashCode()`
`boolean`	`isEqualTo(javax.money.MonetaryAmount amount)`
`boolean`	`isGreaterThan(javax.money.MonetaryAmount amount)`
`boolean`	`isGreaterThanOrEqualTo(javax.money.MonetaryAmount amount)`
`boolean`	`isLessThan(javax.money.MonetaryAmount amount)`
`boolean`	`isLessThanOrEqualTo(javax.money.MonetaryAmount amount)`
`boolean`	`isNegative()`
`boolean`	`isNegativeOrZero()`
`boolean`	`isPositive()`
`boolean`	`isPositiveOrZero()`
`boolean`	`isZero()`
`Money`	`multiply(double multiplicand)`
`Money`	`multiply(long multiplicand)`
`Money`	`multiply(Number multiplicand)`
`Money`	`negate()`
`static Money`	`of(javax.money.CurrencyUnit currency, BigDecimal number)` Creates a new instance of `Money`, using the default `MonetaryContext`.
`static Money`	`of(javax.money.CurrencyUnit currency, BigDecimal number, javax.money.MonetaryContext monetaryContext)` Creates a new instance of `Money`, using an explicit `MonetaryContext`.
`static Money`	`of(javax.money.CurrencyUnit currency, Number number)` Creates a new instance of `Money`, using the default `MonetaryContext`.
`static Money`	`of(javax.money.CurrencyUnit currency, Number number, javax.money.MonetaryContext monetaryContext)` Creates a new instance of `Money`, using an explicit `MonetaryContext`.
`static Money`	`of(String currencyCode, BigDecimal number)` Static factory method for creating a new instance of `Money`.
`static Money`	`of(String currencyCode, BigDecimal number, javax.money.MonetaryContext monetaryContext)` Static factory method for creating a new instance of `Money`.
`static Money`	`of(String currencyCode, Number number)` Static factory method for creating a new instance of `Money`.
`static Money`	`of(String currencyCode, Number number, javax.money.MonetaryContext monetaryContext)` Static factory method for creating a new instance of `Money`.
`Money`	`plus()`
`<R> R`	`query(javax.money.MonetaryQuery<R> query)`
`Money`	`remainder(double divisor)`
`Money`	`remainder(long divisor)`
`Money`	`remainder(Number divisor)`
`Money`	`scaleByPowerOfTen(int n)`
`int`	`signum()`
`Money`	`stripTrailingZeros()`
`Money`	`subtract(javax.money.MonetaryAmount subtrahend)`
`String`	`toString()`
`Money`	`with(javax.money.MonetaryOperator operator)`

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

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

- Field Detail
  - DEFAULT_MONETARY_CONTEXT
```
public static final javax.money.MonetaryContext DEFAULT_MONETARY_CONTEXT
```
    The default MonetaryContext applied, if not set explicitly on creation.
- Method Detail
  - getNumber
```
public javax.money.NumberValue getNumber()
```
    Specified by:
    
    getNumber in interface javax.money.MonetaryAmount
    
    Specified by:
    
    getNumber in interface javax.money.NumberSupplier
  - getNumberStripped
```
public BigDecimal getNumberStripped()
```
    Method that returns BigDecimal.ZERO, if isZero(), and #stripTrailingZeros() in all other cases.
    
    Returns:
    the stripped number value.
  - compareTo
```
public int compareTo(javax.money.MonetaryAmount o)
```
    Specified by:
    
    compareTo in interface Comparable<javax.money.MonetaryAmount>
  - abs
```
public Money abs()
```
    Specified by:
    
    abs in interface javax.money.MonetaryAmount
  - divide
```
public Money divide(long divisor)
```
    Specified by:
    
    divide in interface javax.money.MonetaryAmount
  - divide
```
public Money divide(double divisor)
```
    Specified by:
    
    divide in interface javax.money.MonetaryAmount
  - divideAndRemainder
```
public Money[] divideAndRemainder(long divisor)
```
    Specified by:
    
    divideAndRemainder in interface javax.money.MonetaryAmount
  - divideAndRemainder
```
public Money[] divideAndRemainder(double divisor)
```
    Specified by:
    
    divideAndRemainder in interface javax.money.MonetaryAmount
  - multiply
```
public Money multiply(long multiplicand)
```
    Specified by:
    
    multiply in interface javax.money.MonetaryAmount
  - multiply
```
public Money multiply(double multiplicand)
```
    Specified by:
    
    multiply in interface javax.money.MonetaryAmount
  - remainder
```
public Money remainder(long divisor)
```
    Specified by:
    
    remainder in interface javax.money.MonetaryAmount
  - remainder
```
public Money remainder(double divisor)
```
    Specified by:
    
    remainder 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
  - query
```
public <R> R query(javax.money.MonetaryQuery<R> query)
```
    Specified by:
    
    query in interface javax.money.MonetaryAmount
  - with
```
public Money with(javax.money.MonetaryOperator operator)
```
    Specified by:
    
    with in interface javax.money.MonetaryAmount
  - add
```
public Money add(javax.money.MonetaryAmount amount)
```
    Specified by:
    
    add in interface javax.money.MonetaryAmount
  - divide
```
public Money divide(Number divisor)
```
    Specified by:
    
    divide in interface javax.money.MonetaryAmount
  - divideAndRemainder
```
public Money[] divideAndRemainder(Number divisor)
```
    Specified by:
    
    divideAndRemainder in interface javax.money.MonetaryAmount
  - divideToIntegralValue
```
public Money divideToIntegralValue(long divisor)
```
    Specified by:
    
    divideToIntegralValue in interface javax.money.MonetaryAmount
  - divideToIntegralValue
```
public Money divideToIntegralValue(double divisor)
```
    Specified by:
    
    divideToIntegralValue in interface javax.money.MonetaryAmount
  - divideToIntegralValue
```
public Money divideToIntegralValue(Number divisor)
```
    Specified by:
    
    divideToIntegralValue in interface javax.money.MonetaryAmount
  - multiply
```
public Money multiply(Number multiplicand)
```
    Specified by:
    
    multiply in interface javax.money.MonetaryAmount
  - negate
```
public Money negate()
```
    Specified by:
    
    negate in interface javax.money.MonetaryAmount
  - plus
```
public Money plus()
```
    Specified by:
    
    plus in interface javax.money.MonetaryAmount
  - subtract
```
public Money subtract(javax.money.MonetaryAmount subtrahend)
```
    Specified by:
    
    subtract in interface javax.money.MonetaryAmount
  - stripTrailingZeros
```
public Money stripTrailingZeros()
```
    Specified by:
    
    stripTrailingZeros in interface javax.money.MonetaryAmount
  - remainder
```
public Money remainder(Number divisor)
```
    Specified by:
    
    remainder in interface javax.money.MonetaryAmount
  - scaleByPowerOfTen
```
public Money scaleByPowerOfTen(int n)
```
    Specified by:
    
    scaleByPowerOfTen in interface javax.money.MonetaryAmount
  - 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
  - isLessThanOrEqualTo
```
public boolean isLessThanOrEqualTo(javax.money.MonetaryAmount amount)
```
    Specified by:
    
    isLessThanOrEqualTo in interface javax.money.MonetaryAmount
  - isGreaterThan
```
public boolean isGreaterThan(javax.money.MonetaryAmount amount)
```
    Specified by:
    
    isGreaterThan in interface javax.money.MonetaryAmount
  - isGreaterThanOrEqualTo
```
public boolean isGreaterThanOrEqualTo(javax.money.MonetaryAmount amount)
```
    Specified by:
    
    isGreaterThanOrEqualTo in interface javax.money.MonetaryAmount
  - isEqualTo
```
public boolean isEqualTo(javax.money.MonetaryAmount amount)
```
    Specified by:
    
    isEqualTo in interface javax.money.MonetaryAmount
  - getFactory
```
public javax.money.MonetaryAmountFactory<Money> getFactory()
```
    Specified by:
    
    getFactory 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.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - of
```
public static Money of(javax.money.CurrencyUnit currency,
       BigDecimal number)
```
    Creates a new instance of Money, using the default MonetaryContext.
    
    Parameters:
    number - numeric value, not null.
    currency - currency unit, not null.
    
    Returns:
    a Money combining the numeric value and currency unit.
    
    Throws:
    
    ArithmeticException - If the number exceeds the capabilities of the default MonetaryContext used.
  - of
```
public static Money of(javax.money.CurrencyUnit currency,
       BigDecimal number,
       javax.money.MonetaryContext monetaryContext)
```
    Creates a new instance of Money, using an explicit MonetaryContext.
    
    Parameters:
    number - numeric value, not null.
    currency - currency unit, not null.
    monetaryContext - the MonetaryContext to be used, if null the default MonetaryContext is used.
    
    Returns:
    a Money instance based on the monetary context with the given numeric value, currency unit.
    
    Throws:
    
    ArithmeticException - If the number exceeds the capabilities of the MonetaryContext used.
  - of
```
public static Money of(javax.money.CurrencyUnit currency,
       Number number)
```
    Creates a new instance of Money, using the default MonetaryContext.
    
    Parameters:
    currency - The target currency, not null.
    number - The numeric part, not null.
    
    Returns:
    A new instance of Money.
    
    Throws:
    
    ArithmeticException - If the number exceeds the capabilities of the default MonetaryContext used.
  - of
```
public static Money of(javax.money.CurrencyUnit currency,
       Number number,
       javax.money.MonetaryContext monetaryContext)
```
    Creates a new instance of Money, using an explicit MonetaryContext.
    
    Parameters:
    currency - The target currency, not null.
    number - The numeric part, not null.
    monetaryContext - the MonetaryContext to be used, if null the default MonetaryContext is used.
    
    Returns:
    A new instance of Money.
    
    Throws:
    
    ArithmeticException - If the number exceeds the capabilities of the MonetaryContext used.
  - of
```
public static Money of(String currencyCode,
       Number number)
```
    Static factory method for creating a new instance of Money.
    
    Parameters:
    currencyCode - The target currency as ISO currency code.
    number - The numeric part, not null.
    
    Returns:
    A new instance of Money.
  - of
```
public static Money of(String currencyCode,
       BigDecimal number)
```
    Static factory method for creating a new instance of Money.
    
    Parameters:
    currencyCode - The target currency as ISO currency code.
    number - The numeric part, not null.
    
    Returns:
    A new instance of Money.
  - of
```
public static Money of(String currencyCode,
       Number number,
       javax.money.MonetaryContext monetaryContext)
```
    Static factory method for creating a new instance of Money.
    
    Parameters:
    currencyCode - The target currency as ISO currency code.
    number - The numeric part, not null.
    monetaryContext - the MonetaryContext to be used, if null the default MonetaryContext is used.
    
    Returns:
    A new instance of Money.
  - of
```
public static Money of(String currencyCode,
       BigDecimal number,
       javax.money.MonetaryContext monetaryContext)
```
    Static factory method for creating a new instance of Money.
    
    Parameters:
    currencyCode - The target currency as ISO currency code.
    number - The numeric part, not null.
    monetaryContext - the MonetaryContext to be used, if null the default MonetaryContext is used.
    
    Returns:
    A new instance of Money.
  - from
```
public static Money from(javax.money.MonetaryAmount amt)
```
    Converts (if necessary) the given MonetaryAmount to a Money instance. The MonetaryContext will be adapted as necessary, if the precision of the given amount exceeds the capabilities of the default MonetaryContext.
    
    Parameters:
    amt - the amount to be converted
    
    Returns:
    an according Money instance.

Class Money

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

Field Detail

DEFAULT_MONETARY_CONTEXT

Method Detail

getNumber

getNumberStripped

compareTo

abs

divide

divide

divideAndRemainder

divideAndRemainder

multiply

multiply

remainder

remainder

isZero

isPositive

isPositiveOrZero

isNegative

isNegativeOrZero

query

with

add

divide

divideAndRemainder

divideToIntegralValue

divideToIntegralValue

divideToIntegralValue

multiply

negate

plus

subtract

stripTrailingZeros

remainder

scaleByPowerOfTen

signum

isLessThan

isLessThanOrEqualTo

isGreaterThan

isGreaterThanOrEqualTo

isEqualTo

getFactory

getDefaultMonetaryContext

equals

toString

hashCode

of

of

of

of

of

of

of

of

from