Money (Moneta (JSR 354 RI) for Java 7 1.4.1 API)

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

All Implemented Interfaces:

Serializable, Comparable<MonetaryAmount>, CurrencySupplier, MonetaryAmount, NumberSupplier
```
public final class Money
extends Object
implements MonetaryAmount, Comparable<MonetaryAmount>, Serializable
```
Default immutable implementation of MonetaryAmount based on BigDecimal as 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.7

Author:

Anatole Tresch, Werner Keil

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static MonetaryContext DEFAULT_MONETARY_CONTEXT
The default MonetaryContext applied, if not set explicitly on creation.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Money`	`abs()`
`Money`	`add(MonetaryAmount amount)`
`static void`	`checkNoInfinityOrNaN(Number number)` Deprecated. Will be removed.
`int`	`compareTo(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(MonetaryAmount amt)` Converts (if necessary) the given `MonetaryAmount` to a `Money` instance.
`MonetaryContext`	`getContext()` Access the `MonetaryContext` used by this instance.
`CurrencyUnit`	`getCurrency()` Returns the amount’s currency, modelled as `CurrencyUnit`.
`MonetaryAmountFactory<Money>`	`getFactory()`
`NumberValue`	`getNumber()` Gets the number representation of the numeric value of this item.
`BigDecimal`	`getNumberStripped()` Method that returns BigDecimal.ZERO, if `isZero()`, and `#stripTrailingZeros()` in all other cases.
`int`	`hashCode()`
`boolean`	`isEqualTo(MonetaryAmount amount)`
`boolean`	`isGreaterThan(MonetaryAmount amount)`
`boolean`	`isGreaterThanOrEqualTo(MonetaryAmount amount)`
`static boolean`	`isInfinityAndNotNaN(Number number)` Deprecated. Will be removed.
`boolean`	`isLessThan(MonetaryAmount amount)`
`boolean`	`isLessThanOrEqualTo(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(BigDecimal number, CurrencyUnit currency)` Creates a new instance of `Money`, using the default `MonetaryContext`.
`static Money`	`of(BigDecimal number, CurrencyUnit currency, MonetaryContext monetaryContext)` Creates a new instance of `Money`, using an explicit `MonetaryContext`.
`static Money`	`of(BigDecimal number, String currencyCode)` Static factory method for creating a new instance of `Money`.
`static Money`	`of(BigDecimal number, String currencyCode, MonetaryContext monetaryContext)` Static factory method for creating a new instance of `Money`.
`static Money`	`of(Number number, CurrencyUnit currency)` Creates a new instance of `Money`, using the default `MonetaryContext`.
`static Money`	`of(Number number, CurrencyUnit currency, MonetaryContext monetaryContext)` Creates a new instance of `Money`, using an explicit `MonetaryContext`.
`static Money`	`of(Number number, String currencyCode)` Static factory method for creating a new instance of `Money`.
`static Money`	`of(Number number, String currencyCode, MonetaryContext monetaryContext)` Static factory method for creating a new instance of `Money`.
`static Money`	`ofMinor(CurrencyUnit currency, long amountMinor)` Obtains an instance of `Money` from an amount in minor units.
`static Money`	`ofMinor(CurrencyUnit currency, long amountMinor, int factionDigits)` Obtains an instance of `Money` from an amount in minor units.
`static Money`	`parse(CharSequence text)` Obtains an instance of Money from a text string such as 'EUR 25.25'.
`static Money`	`parse(CharSequence text, MonetaryAmountFormat formatter)` Obtains an instance of Money from a text using specific formatter.
`Money`	`plus()`
`<R> R`	`query(MonetaryQuery<R> query)`
`Money`	`remainder(double divisor)`
`Money`	`remainder(long divisor)`
`Money`	`remainder(Number divisor)`
`Money`	`scaleByPowerOfTen(int power)`
`int`	`signum()`
`Money`	`stripTrailingZeros()`
`Money`	`subtract(MonetaryAmount subtrahend)`
`String`	`toString()`
`Money`	`with(MonetaryOperator operator)`
`static Money`	`zero(CurrencyUnit currency)` Obtains an instance of `Money` representing zero.

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

- Field Detail
  - DEFAULT_MONETARY_CONTEXT
```
public static final MonetaryContext DEFAULT_MONETARY_CONTEXT
```
    The default MonetaryContext applied, if not set explicitly on creation.
- Method Detail
  - getCurrency
```
public CurrencyUnit getCurrency()
```
    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 CurrencySupplier
    
    Returns:
    
    the currency, never null
    
    See Also:
    
    CurrencySupplier.getCurrency()
  - getContext
```
public MonetaryContext getContext()
```
    Access the MonetaryContext used by this instance.
    
    Specified by:
    
    getContext in interface MonetaryAmount
    
    Returns:
    
    the MonetaryContext used, never null.
    
    See Also:
    
    MonetaryAmount.getContext()
  - getNumber
```
public NumberValue getNumber()
```
    Gets the number representation of the numeric value of this item.
    
    Specified by:
    
    getNumber in interface NumberSupplier
    
    Returns:
    
    The Number representation matching best.
  - 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(MonetaryAmount o)
```
    Specified by:
    
    compareTo in interface Comparable<MonetaryAmount>
  - abs
```
public Money abs()
```
    Specified by:
    
    abs in interface MonetaryAmount
  - divide
```
public Money divide(long divisor)
```
    Specified by:
    
    divide in interface MonetaryAmount
  - divide
```
public Money divide(double divisor)
```
    Specified by:
    
    divide in interface MonetaryAmount
  - divideAndRemainder
```
public Money[] divideAndRemainder(long divisor)
```
    Specified by:
    
    divideAndRemainder in interface MonetaryAmount
  - divideAndRemainder
```
public Money[] divideAndRemainder(double divisor)
```
    Specified by:
    
    divideAndRemainder in interface MonetaryAmount
  - multiply
```
public Money multiply(long multiplicand)
```
    Specified by:
    
    multiply in interface MonetaryAmount
  - multiply
```
public Money multiply(double multiplicand)
```
    Specified by:
    
    multiply in interface MonetaryAmount
  - remainder
```
public Money remainder(long divisor)
```
    Specified by:
    
    remainder in interface MonetaryAmount
  - remainder
```
public Money remainder(double divisor)
```
    Specified by:
    
    remainder in interface MonetaryAmount
  - isZero
```
public boolean isZero()
```
    Specified by:
    
    isZero in interface MonetaryAmount
  - isPositive
```
public boolean isPositive()
```
    Specified by:
    
    isPositive in interface MonetaryAmount
  - isPositiveOrZero
```
public boolean isPositiveOrZero()
```
    Specified by:
    
    isPositiveOrZero in interface MonetaryAmount
  - isNegative
```
public boolean isNegative()
```
    Specified by:
    
    isNegative in interface MonetaryAmount
  - isNegativeOrZero
```
public boolean isNegativeOrZero()
```
    Specified by:
    
    isNegativeOrZero in interface MonetaryAmount
  - query
```
public <R> R query(MonetaryQuery<R> query)
```
    Specified by:
    
    query in interface MonetaryAmount
  - with
```
public Money with(MonetaryOperator operator)
```
    Specified by:
    
    with in interface MonetaryAmount
  - add
```
public Money add(MonetaryAmount amount)
```
    Specified by:
    
    add in interface MonetaryAmount
  - divide
```
public Money divide(Number divisor)
```
    Specified by:
    
    divide in interface MonetaryAmount
  - divideAndRemainder
```
public Money[] divideAndRemainder(Number divisor)
```
    Specified by:
    
    divideAndRemainder in interface MonetaryAmount
  - divideToIntegralValue
```
public Money divideToIntegralValue(long divisor)
```
    Specified by:
    
    divideToIntegralValue in interface MonetaryAmount
  - divideToIntegralValue
```
public Money divideToIntegralValue(double divisor)
```
    Specified by:
    
    divideToIntegralValue in interface MonetaryAmount
  - divideToIntegralValue
```
public Money divideToIntegralValue(Number divisor)
```
    Specified by:
    
    divideToIntegralValue in interface MonetaryAmount
  - multiply
```
public Money multiply(Number multiplicand)
```
    Specified by:
    
    multiply in interface MonetaryAmount
  - negate
```
public Money negate()
```
    Specified by:
    
    negate in interface MonetaryAmount
  - plus
```
public Money plus()
```
    Specified by:
    
    plus in interface MonetaryAmount
  - subtract
```
public Money subtract(MonetaryAmount subtrahend)
```
    Specified by:
    
    subtract in interface MonetaryAmount
  - stripTrailingZeros
```
public Money stripTrailingZeros()
```
    Specified by:
    
    stripTrailingZeros in interface MonetaryAmount
  - remainder
```
public Money remainder(Number divisor)
```
    Specified by:
    
    remainder in interface MonetaryAmount
  - scaleByPowerOfTen
```
public Money scaleByPowerOfTen(int power)
```
    Specified by:
    
    scaleByPowerOfTen in interface MonetaryAmount
  - signum
```
public int signum()
```
    Specified by:
    
    signum in interface MonetaryAmount
  - isLessThan
```
public boolean isLessThan(MonetaryAmount amount)
```
    Specified by:
    
    isLessThan in interface MonetaryAmount
  - isLessThanOrEqualTo
```
public boolean isLessThanOrEqualTo(MonetaryAmount amount)
```
    Specified by:
    
    isLessThanOrEqualTo in interface MonetaryAmount
  - isGreaterThan
```
public boolean isGreaterThan(MonetaryAmount amount)
```
    Specified by:
    
    isGreaterThan in interface MonetaryAmount
  - isGreaterThanOrEqualTo
```
public boolean isGreaterThanOrEqualTo(MonetaryAmount amount)
```
    Specified by:
    
    isGreaterThanOrEqualTo in interface MonetaryAmount
  - isEqualTo
```
public boolean isEqualTo(MonetaryAmount amount)
```
    Specified by:
    
    isEqualTo in interface MonetaryAmount
  - getFactory
```
public MonetaryAmountFactory<Money> getFactory()
```
    Specified by:
    
    getFactory in interface MonetaryAmount
  - 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(BigDecimal number,
                       CurrencyUnit currency)
```
    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(BigDecimal number,
                       CurrencyUnit currency,
                       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(Number number,
                       CurrencyUnit currency)
```
    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(Number number,
                       CurrencyUnit currency,
                       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(Number number,
                       String currencyCode)
```
    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(BigDecimal number,
                       String currencyCode)
```
    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(Number number,
                       String currencyCode,
                       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(BigDecimal number,
                       String currencyCode,
                       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.
  - zero
```
public static Money zero(CurrencyUnit currency)
```
    Obtains an instance of Money representing zero.
    
    Parameters:
    
    currency - the currency, not null.
    
    Returns:
    
    an instance of Money representing zero.
    
    Since:
    
    1.0.1
  - ofMinor
```
public static Money ofMinor(CurrencyUnit currency,
                            long amountMinor)
```
    Obtains an instance of Money from an amount in minor units. For example, ofMinor(USD, 1234) creates the instance USD 12.34.
    
    Parameters:
    
    currency - the currency
    
    amountMinor - the amount of money in the minor division of the currency
    
    Returns:
    
    the Money from minor units
    
    Throws:
    
    NullPointerException - when the currency is null
    
    IllegalArgumentException - when CurrencyUnit.getDefaultFractionDigits() is lesser than zero.
    
    Since:
    
    1.0.1
    
    See Also:
    
    CurrencyUnit.getDefaultFractionDigits()
  - ofMinor
```
public static Money ofMinor(CurrencyUnit currency,
                            long amountMinor,
                            int factionDigits)
```
    Obtains an instance of Money from an amount in minor units. For example, ofMinor(USD, 1234, 2) creates the instance USD 12.34.
    
    Parameters:
    
    currency - the currency, not null
    
    amountMinor - the amount of money in the minor division of the currency
    
    factionDigits - number of digits
    
    Returns:
    
    the monetary amount from minor units
    
    Throws:
    
    NullPointerException - when the currency is null
    
    IllegalArgumentException - when the factionDigits is negative
    
    Since:
    
    1.0.1
    
    See Also:
    
    CurrencyUnit.getDefaultFractionDigits(), ofMinor(CurrencyUnit, long, int)
  - from
```
public static Money from(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.
  - parse
```
public static Money parse(CharSequence text)
```
    Obtains an instance of Money from a text string such as 'EUR 25.25'.
    
    Parameters:
    
    text - the text to parse, not null
    
    Returns:
    
    Money instance
    
    Throws:
    
    NumberFormatException - if the amount is not parseable.
    
    UnknownCurrencyException - if the currency is not resolvable.
  - parse
```
public static Money parse(CharSequence text,
                          MonetaryAmountFormat formatter)
```
    Obtains an instance of Money from a text using specific formatter.
    
    Parameters:
    
    text - the text to parse not null
    
    formatter - the formatter to use not null
    
    Returns:
    
    Money instance
  - isInfinityAndNotNaN
```
@Deprecated
public static boolean isInfinityAndNotNaN(Number number)
```
    Deprecated. Will be removed.
    
    Just to don't break the compatibility. Don't use it
    
    Parameters:
    
    number - the number, not null.
  - checkNoInfinityOrNaN
```
@Deprecated
public static void checkNoInfinityOrNaN(Number number)
```
    Deprecated. Will be removed.
    
    Just to don't break the compatibility. Don't use it
    
    Parameters:
    
    number - the number, not null.

Class Money

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_MONETARY_CONTEXT

Method Detail

getCurrency

getContext

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

equals

toString

hashCode

of

of

of

of

of

of

of

of

zero

ofMinor

ofMinor

from

parse

parse

isInfinityAndNotNaN

checkNoInfinityOrNaN