RoundedMoney (Moneta (JSR 354 RI) 0.8 API)

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

All Implemented Interfaces:

Serializable, Comparable<javax.money.MonetaryAmount>, javax.money.CurrencySupplier, javax.money.MonetaryAmount, javax.money.NumberSupplier
```
public final class RoundedMoney
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.

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.
- 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.

Method Summary

Methods
Modifier and Type	Method and Description
`RoundedMoney`	`abs()`
`RoundedMoney`	`add(javax.money.MonetaryAmount amount)`
`BigDecimal`	`asNumberStripped()` Method that returns BigDecimal.ZERO, if `isZero()`, and #number `stripTrailingZeros()` in all other cases.
`<T> T`	`asType(Class<T> type)`
`<T> T`	`asType(Class<T> type, javax.money.MonetaryOperator adjuster)`
`int`	`compareTo(javax.money.MonetaryAmount o)`
`RoundedMoney`	`divide(double amount)`
`RoundedMoney`	`divide(long amount)`
`RoundedMoney`	`divide(Number divisor)`
`RoundedMoney[]`	`divideAndRemainder(double amount)`
`RoundedMoney[]`	`divideAndRemainder(long amount)`
`RoundedMoney[]`	`divideAndRemainder(Number divisor)`
`RoundedMoney`	`divideToIntegralValue(double divisor)`
`RoundedMoney`	`divideToIntegralValue(long divisor)`
`RoundedMoney`	`divideToIntegralValue(Number divisor)`
`boolean`	`equals(Object obj)`
`static RoundedMoney`	`from(javax.money.MonetaryAmount amt)`
`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<RoundedMoney>`	`getFactory()`
`javax.money.MonetaryContext`	`getMonetaryContext()` Access the `MathContext` used by this instance.
`javax.money.NumberValue`	`getNumber()`
`int`	`getPrecision()`
`int`	`getScale()`
`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`	`isNotEqualTo(javax.money.MonetaryAmount amount)`
`boolean`	`isPositive()`
`boolean`	`isPositiveOrZero()`
`boolean`	`isZero()`
`RoundedMoney`	`multiply(double amount)`
`RoundedMoney`	`multiply(long amount)`
`RoundedMoney`	`multiply(Number multiplicand)`
`RoundedMoney`	`negate()`
`static RoundedMoney`	`of(javax.money.CurrencyUnit currency, BigDecimal number)` Translates a `BigDecimal` value and a `CurrencyUnit` currency into a `Money`.
`static RoundedMoney`	`of(javax.money.CurrencyUnit currency, BigDecimal number, javax.money.MonetaryContext monetaryContext)` Translates a `BigDecimal` value and a `CurrencyUnit` currency into a `Money`.
`static RoundedMoney`	`of(javax.money.CurrencyUnit currency, BigDecimal number, javax.money.MonetaryContext monetaryContext, javax.money.MonetaryOperator rounding)` Translates a `BigDecimal` value and a `CurrencyUnit` currency into a `Money`.
`static RoundedMoney`	`of(javax.money.CurrencyUnit currency, BigDecimal number, javax.money.MonetaryOperator rounding)` Translates a `BigDecimal` value and a `CurrencyUnit` currency into a `Money`.
`static RoundedMoney`	`of(javax.money.CurrencyUnit currency, Number number)` Static factory method for creating a new instance of `RoundedMoney` .
`static RoundedMoney`	`of(javax.money.CurrencyUnit currency, Number number, javax.money.MonetaryContext monetaryContext)` Static factory method for creating a new instance of `RoundedMoney` .
`static RoundedMoney`	`of(javax.money.CurrencyUnit currency, Number number, javax.money.MonetaryContext monetaryContext, javax.money.MonetaryOperator rounding)` Static factory method for creating a new instance of `RoundedMoney` .
`static RoundedMoney`	`of(javax.money.CurrencyUnit currency, Number number, javax.money.MonetaryOperator rounding)` Static factory method for creating a new instance of `RoundedMoney` .
`static RoundedMoney`	`of(String currencyCode, Number number)` Static factory method for creating a new instance of `RoundedMoney` .
`static RoundedMoney`	`of(String currencyCode, Number number, javax.money.MonetaryContext monetaryContext)` Static factory method for creating a new instance of `RoundedMoney` .
`static RoundedMoney`	`of(String currencyCode, Number number, javax.money.MonetaryContext monetaryContext, javax.money.MonetaryOperator rounding)` Static factory method for creating a new instance of `RoundedMoney` .
`static RoundedMoney`	`of(String currencyCode, Number number, javax.money.MonetaryOperator rounding)` Static factory method for creating a new instance of `RoundedMoney` .
`RoundedMoney`	`plus()`
`RoundedMoney`	`pow(int n)`
`<T> T`	`query(javax.money.MonetaryQuery<T> query)`
`RoundedMoney`	`remainder(double amount)`
`RoundedMoney`	`remainder(long amount)`
`RoundedMoney`	`remainder(Number divisor)`
`RoundedMoney`	`scaleByPowerOfTen(int n)`
`int`	`signum()`
`RoundedMoney`	`stripTrailingZeros()`
`RoundedMoney`	`subtract(javax.money.MonetaryAmount subtrahend)`
`String`	`toString()`
`RoundedMoney`	`ulp()`
`RoundedMoney`	`with(javax.money.CurrencyUnit currency)` Creates a new Money instance, by just replacing the `CurrencyUnit`.
`RoundedMoney`	`with(javax.money.CurrencyUnit currency, Number amount)`
`RoundedMoney`	`with(javax.money.MonetaryOperator operator)`
`RoundedMoney`	`with(Number amount)`

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

- Field Detail
  - DEFAULT_MONETARY_CONTEXT
```
public static final javax.money.MonetaryContext DEFAULT_MONETARY_CONTEXT
```
    The default MonetaryContext applied.
- Method Detail
  - of
```
public static RoundedMoney of(javax.money.CurrencyUnit currency,
              BigDecimal number)
```
    Translates a BigDecimal value and a CurrencyUnit currency into a Money.
    
    Parameters:
    number - numeric value of the Money.
    currency - currency unit of the Money.
    
    Returns:
    a Money combining the numeric value and currency unit.
  - of
```
public static RoundedMoney of(javax.money.CurrencyUnit currency,
              BigDecimal number,
              javax.money.MonetaryOperator rounding)
```
    Translates a BigDecimal value and a CurrencyUnit currency into a Money.
    
    Parameters:
    number - numeric value of the Money.
    currency - currency unit of the Money.
    rounding - The rounding to be applied.
    
    Returns:
    a Money combining the numeric value and currency unit.
  - of
```
public static RoundedMoney of(javax.money.CurrencyUnit currency,
              BigDecimal number,
              javax.money.MonetaryContext monetaryContext)
```
    Translates a BigDecimal value and a CurrencyUnit currency into a Money.
    
    Parameters:
    number - numeric value of the Money.
    currency - currency unit of the Money.
    monetaryContext - the MathContext to be used.
    
    Returns:
    a Money combining the numeric value and currency unit.
  - of
```
public static RoundedMoney of(javax.money.CurrencyUnit currency,
              BigDecimal number,
              javax.money.MonetaryContext monetaryContext,
              javax.money.MonetaryOperator rounding)
```
    Translates a BigDecimal value and a CurrencyUnit currency into a Money.
    
    Parameters:
    number - numeric value of the Money.
    currency - currency unit of the Money.
    mathContext - the MathContext to be used.
    rounding - The rounding to be applied.
    
    Returns:
    a Money combining the numeric value and currency unit.
  - of
```
public static RoundedMoney of(javax.money.CurrencyUnit currency,
              Number number)
```
    Static factory method for creating a new instance of RoundedMoney .
    
    Parameters:
    currency - The target currency, not null.
    number - The numeric part, not null.
    
    Returns:
    A new instance of RoundedMoney.
  - of
```
public static RoundedMoney of(javax.money.CurrencyUnit currency,
              Number number,
              javax.money.MonetaryOperator rounding)
```
    Static factory method for creating a new instance of RoundedMoney .
    
    Parameters:
    currency - The target currency, not null.
    number - The numeric part, not null.
    rounding - The rounding to be applied.
    
    Returns:
    A new instance of RoundedMoney.
  - of
```
public static RoundedMoney of(javax.money.CurrencyUnit currency,
              Number number,
              javax.money.MonetaryContext monetaryContext)
```
    Static factory method for creating a new instance of RoundedMoney .
    
    Parameters:
    currency - The target currency, not null.
    number - The numeric part, not null.
    
    Returns:
    A new instance of RoundedMoney.
  - of
```
public static RoundedMoney of(javax.money.CurrencyUnit currency,
              Number number,
              javax.money.MonetaryContext monetaryContext,
              javax.money.MonetaryOperator rounding)
```
    Static factory method for creating a new instance of RoundedMoney .
    
    Parameters:
    currency - The target currency, not null.
    number - The numeric part, not null.
    monetaryContext - the MonetaryContext to be used.
    rounding - The rounding to be applied.
    
    Returns:
    A new instance of RoundedMoney.
  - of
```
public static RoundedMoney of(String currencyCode,
              Number number)
```
    Static factory method for creating a new instance of RoundedMoney .
    
    Parameters:
    isoCurrencyCode - The target currency as ISO currency code.
    number - The numeric part, not null.
    
    Returns:
    A new instance of RoundedMoney.
  - of
```
public static RoundedMoney of(String currencyCode,
              Number number,
              javax.money.MonetaryOperator rounding)
```
    Static factory method for creating a new instance of RoundedMoney .
    
    Parameters:
    isoCurrencyCode - The target currency as ISO currency code.
    number - The numeric part, not null.
    rounding - The rounding to be applied.
    
    Returns:
    A new instance of RoundedMoney.
  - of
```
public static RoundedMoney of(String currencyCode,
              Number number,
              javax.money.MonetaryContext monetaryContext)
```
    Static factory method for creating a new instance of RoundedMoney .
    
    Parameters:
    isoCurrencyCode - The target currency as ISO currency code.
    number - The numeric part, not null.
    
    Returns:
    A new instance of RoundedMoney.
  - of
```
public static RoundedMoney of(String currencyCode,
              Number number,
              javax.money.MonetaryContext monetaryContext,
              javax.money.MonetaryOperator rounding)
```
    Static factory method for creating a new instance of RoundedMoney .
    
    Parameters:
    isoCurrencyCode - The target currency as ISO currency code.
    number - The numeric part, not null.
    rounding - The rounding to be applied.
    
    Returns:
    A new instance of RoundedMoney.
  - 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()
  - getMonetaryContext
```
public javax.money.MonetaryContext getMonetaryContext()
```
    Access the MathContext used by this instance.
    
    Specified by:
    
    getMonetaryContext in interface javax.money.MonetaryAmount
    
    Overrides:
    
    getMonetaryContext in class AbstractMoney
    
    Returns:
    the MathContext used, never null.
    See Also:
    MonetaryAmount.getMonetaryContext()
  - abs
```
public RoundedMoney abs()
```
    Specified by:
    
    abs in interface javax.money.MonetaryAmount
  - add
```
public RoundedMoney add(javax.money.MonetaryAmount amount)
```
    Specified by:
    
    add in interface javax.money.MonetaryAmount
  - divide
```
public RoundedMoney divide(Number divisor)
```
    Specified by:
    
    divide in interface javax.money.MonetaryAmount
  - divideAndRemainder
```
public RoundedMoney[] divideAndRemainder(Number divisor)
```
    Specified by:
    
    divideAndRemainder in interface javax.money.MonetaryAmount
  - divideToIntegralValue
```
public RoundedMoney divideToIntegralValue(Number divisor)
```
    Specified by:
    
    divideToIntegralValue in interface javax.money.MonetaryAmount
  - multiply
```
public RoundedMoney multiply(Number multiplicand)
```
    Specified by:
    
    multiply in interface javax.money.MonetaryAmount
  - negate
```
public RoundedMoney negate()
```
    Specified by:
    
    negate in interface javax.money.MonetaryAmount
  - plus
```
public RoundedMoney plus()
```
    Specified by:
    
    plus in interface javax.money.MonetaryAmount
  - subtract
```
public RoundedMoney subtract(javax.money.MonetaryAmount subtrahend)
```
    Specified by:
    
    subtract in interface javax.money.MonetaryAmount
  - pow
```
public RoundedMoney pow(int n)
```
  - ulp
```
public RoundedMoney ulp()
```
  - remainder
```
public RoundedMoney remainder(Number divisor)
```
    Specified by:
    
    remainder in interface javax.money.MonetaryAmount
  - scaleByPowerOfTen
```
public RoundedMoney 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
  - with
```
public RoundedMoney with(Number amount)
```
  - with
```
public RoundedMoney with(javax.money.CurrencyUnit currency)
```
    Creates a new Money instance, by just replacing the CurrencyUnit.
    
    Parameters:
    currency - the currency unit to be replaced, not null
    
    Returns:
    the new amount with the same numeric value and MathContext, but the new CurrencyUnit.
  - with
```
public RoundedMoney with(javax.money.CurrencyUnit currency,
                Number amount)
```
  - 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
  - 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
  - isNotEqualTo
```
public boolean isNotEqualTo(javax.money.MonetaryAmount amount)
```
  - with
```
public RoundedMoney with(javax.money.MonetaryOperator operator)
```
    Specified by:
    
    with in interface javax.money.MonetaryAmount
  - from
```
public static RoundedMoney from(javax.money.MonetaryAmount amt)
```
  - query
```
public <T> T query(javax.money.MonetaryQuery<T> query)
```
    Specified by:
    
    query in interface javax.money.MonetaryAmount
  - asType
```
public <T> T asType(Class<T> type)
```
  - asType
```
public <T> T asType(Class<T> type,
           javax.money.MonetaryOperator adjuster)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - compareTo
```
public int compareTo(javax.money.MonetaryAmount o)
```
    Specified by:
    
    compareTo in interface Comparable<javax.money.MonetaryAmount>
  - getNumber
```
public javax.money.NumberValue getNumber()
```
    Specified by:
    
    getNumber in interface javax.money.MonetaryAmount
    
    Specified by:
    
    getNumber in interface javax.money.NumberSupplier
  - asNumberStripped
```
public BigDecimal asNumberStripped()
```
    Method that returns BigDecimal.ZERO, if isZero(), and #number stripTrailingZeros() in all other cases.
    
    Returns:
    the stripped number value.
  - multiply
```
public RoundedMoney multiply(long amount)
```
    Specified by:
    
    multiply in interface javax.money.MonetaryAmount
  - multiply
```
public RoundedMoney multiply(double amount)
```
    Specified by:
    
    multiply in interface javax.money.MonetaryAmount
  - divide
```
public RoundedMoney divide(long amount)
```
    Specified by:
    
    divide in interface javax.money.MonetaryAmount
  - divide
```
public RoundedMoney divide(double amount)
```
    Specified by:
    
    divide in interface javax.money.MonetaryAmount
  - remainder
```
public RoundedMoney remainder(long amount)
```
    Specified by:
    
    remainder in interface javax.money.MonetaryAmount
  - remainder
```
public RoundedMoney remainder(double amount)
```
    Specified by:
    
    remainder in interface javax.money.MonetaryAmount
  - divideAndRemainder
```
public RoundedMoney[] divideAndRemainder(long amount)
```
    Specified by:
    
    divideAndRemainder in interface javax.money.MonetaryAmount
  - divideAndRemainder
```
public RoundedMoney[] divideAndRemainder(double amount)
```
    Specified by:
    
    divideAndRemainder in interface javax.money.MonetaryAmount
  - stripTrailingZeros
```
public RoundedMoney stripTrailingZeros()
```
    Specified by:
    
    stripTrailingZeros in interface javax.money.MonetaryAmount
  - divideToIntegralValue
```
public RoundedMoney divideToIntegralValue(long divisor)
```
    Specified by:
    
    divideToIntegralValue in interface javax.money.MonetaryAmount
  - divideToIntegralValue
```
public RoundedMoney 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<RoundedMoney> getFactory()
```
    Specified by:
    
    getFactory in interface javax.money.MonetaryAmount

Class RoundedMoney

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

of

of

of

of

of

of

of

of

of

of

of

of

getCurrency

getMonetaryContext

abs

add

divide

divideAndRemainder

divideToIntegralValue

multiply

negate

plus

subtract

pow

ulp

remainder

scaleByPowerOfTen

isZero

isPositive

isPositiveOrZero

isNegative

isNegativeOrZero

with

with

with

getScale

getPrecision

signum

isLessThan

isLessThanOrEqualTo

isGreaterThan

isGreaterThanOrEqualTo

isEqualTo

isNotEqualTo

with

from

query

asType

asType

toString

hashCode

equals

compareTo

getNumber

asNumberStripped

multiply

multiply

divide

divide

remainder

remainder

divideAndRemainder

divideAndRemainder

stripTrailingZeros

divideToIntegralValue

divideToIntegralValue

getDefaultMonetaryContext

getFactory