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

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

All Implemented Interfaces:

Serializable, Comparable<MonetaryAmount>, CurrencySupplier, MonetaryAmount, NumberSupplier
```
public final class RoundedMoney
extends Object
implements MonetaryAmount, Comparable<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 MonetaryContext DEFAULT_MONETARY_CONTEXT
The default MonetaryContext applied.

static String MONETARY_ROUNDING_KEY

Fields
Modifier and Type	Field and Description
`static MonetaryContext`	`DEFAULT_MONETARY_CONTEXT` The default `MonetaryContext` applied.
`static String`	`MONETARY_ROUNDING_KEY`

Constructor Summary

Constructors
Constructor and Description
`RoundedMoney(Number number, CurrencyUnit currency, MathContext mathContext)` Deprecated.
`RoundedMoney(Number number, CurrencyUnit currency, MonetaryContext context, MonetaryOperator rounding)` Deprecated.
`RoundedMoney(Number number, CurrencyUnit currency, MonetaryOperator rounding)` Creates a new instance os `RoundedMoney`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`RoundedMoney`	`abs()`
`RoundedMoney`	`add(MonetaryAmount amount)`
`BigDecimal`	`asNumberStripped()` Method that returns BigDecimal.ZERO, if `isZero()`, and #number `stripTrailingZeros()` in all other cases.
`<T> T`	`asType(Class<T> type)` Deprecated.
`<T> T`	`asType(Class<T> type, MonetaryOperator adjuster)` Deprecated.
`int`	`compareTo(MonetaryAmount o)`
`RoundedMoney`	`divide(double divisor)`
`RoundedMoney`	`divide(long divisor)`
`RoundedMoney`	`divide(Number divisor)`
`RoundedMoney[]`	`divideAndRemainder(double divisor)`
`RoundedMoney[]`	`divideAndRemainder(long divisor)`
`RoundedMoney[]`	`divideAndRemainder(Number divisor)`
`RoundedMoney`	`divideToIntegralValue(double divisor)`
`RoundedMoney`	`divideToIntegralValue(long divisor)`
`RoundedMoney`	`divideToIntegralValue(Number divisor)`
`boolean`	`equals(Object obj)`
`static RoundedMoney`	`from(MonetaryAmount amt)`
`MonetaryContext`	`getContext()` Access the `MathContext` used by this instance.
`CurrencyUnit`	`getCurrency()`
`MonetaryAmountFactory<RoundedMoney>`	`getFactory()`
`NumberValue`	`getNumber()`
`int`	`getPrecision()`
`int`	`getScale()`
`int`	`hashCode()`
`boolean`	`isEqualTo(MonetaryAmount amount)`
`boolean`	`isGreaterThan(MonetaryAmount amount)`
`boolean`	`isGreaterThanOrEqualTo(MonetaryAmount amount)`
`boolean`	`isLessThan(MonetaryAmount amount)`
`boolean`	`isLessThanOrEqualTo(MonetaryAmount amount)`
`boolean`	`isNegative()`
`boolean`	`isNegativeOrZero()`
`boolean`	`isNotEqualTo(MonetaryAmount amount)`
`boolean`	`isPositive()`
`boolean`	`isPositiveOrZero()`
`boolean`	`isZero()`
`RoundedMoney`	`multiply(double multiplicand)`
`RoundedMoney`	`multiply(long multiplicand)`
`RoundedMoney`	`multiply(Number multiplicand)`
`RoundedMoney`	`negate()`
`static RoundedMoney`	`of(BigDecimal number, CurrencyUnit currency)` Translates a `BigDecimal` value and a `CurrencyUnit` currency into a `Money`.
`static RoundedMoney`	`of(BigDecimal number, CurrencyUnit currency, MathContext mathContext)` Translates a `BigDecimal` value and a `CurrencyUnit` currency into a `Money`.
`static RoundedMoney`	`of(BigDecimal number, CurrencyUnit currency, MonetaryOperator rounding)` Translates a `BigDecimal` value and a `CurrencyUnit` currency into a `Money`.
`static RoundedMoney`	`of(CurrencyUnit currency, Number number, MonetaryContext monetaryContext, MonetaryOperator rounding)` Deprecated.
`static RoundedMoney`	`of(Number number, CurrencyUnit currency)` Deprecated.
`static RoundedMoney`	`of(Number number, CurrencyUnit currency, MonetaryContext monetaryContext)` Static factory method for creating a new instance of `RoundedMoney` .
`static RoundedMoney`	`of(Number number, CurrencyUnit currency, MonetaryOperator rounding)` Static factory method for creating a new instance of `RoundedMoney` .
`static RoundedMoney`	`of(Number number, String currencyCode)` Deprecated.
`static RoundedMoney`	`of(Number number, String currencyCode, MonetaryContext monetaryContext)` Deprecated.
`static RoundedMoney`	`of(Number number, String currencyCode, MonetaryOperator rounding)` Static factory method for creating a new instance of `RoundedMoney` .
`static RoundedMoney`	`of(String currencyCode, Number number, MonetaryContext monetaryContext, MonetaryOperator rounding)` Static factory method for creating a new instance of `RoundedMoney` .
`static RoundedMoney`	`ofMinor(CurrencyUnit currency, long amountMinor)` Obtains an instance of `FastMoney` from an amount in minor units.
`static RoundedMoney`	`ofMinor(CurrencyUnit currency, long amountMinor, int factionDigits)` Obtains an instance of `Money` from an amount in minor units.
`static RoundedMoney`	`parse(CharSequence text)` Obtains an instance of RoundedMoney from a text string such as 'EUR 25.25'.
`static RoundedMoney`	`parse(CharSequence text, MonetaryAmountFormat formatter)` Obtains an instance of FastMoney from a text using specific formatter.
`RoundedMoney`	`plus()`
`RoundedMoney`	`pow(int n)`
`<T> T`	`query(MonetaryQuery<T> query)`
`RoundedMoney`	`remainder(double divisor)`
`RoundedMoney`	`remainder(long divisor)`
`RoundedMoney`	`remainder(Number divisor)`
`RoundedMoney`	`scaleByPowerOfTen(int n)`
`int`	`signum()`
`RoundedMoney`	`stripTrailingZeros()`
`RoundedMoney`	`subtract(MonetaryAmount subtrahend)`
`String`	`toString()`
`RoundedMoney`	`ulp()`
`RoundedMoney`	`with(CurrencyUnit currency)` Creates a new Money instance, by just replacing the `CurrencyUnit`.
`RoundedMoney`	`with(CurrencyUnit currency, Number amount)`
`RoundedMoney`	`with(MonetaryOperator operator)`
`RoundedMoney`	`with(Number amount)`
`static RoundedMoney`	`zero(CurrencyUnit currency)` Obtains an instance of `RoundedMoney` representing zero.

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

- Field Detail
  - MONETARY_ROUNDING_KEY
```
public static final String MONETARY_ROUNDING_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MONETARY_CONTEXT
```
public static final MonetaryContext DEFAULT_MONETARY_CONTEXT
```
    The default MonetaryContext applied.
- Constructor Detail
  - RoundedMoney
```
public RoundedMoney(Number number,
                    CurrencyUnit currency,
                    MonetaryOperator rounding)
```
    Creates a new instance os RoundedMoney.
    
    Parameters:
    
    currency - the currency, not null.
    
    number - the amount, not null.
  - RoundedMoney
```
@Deprecated
public RoundedMoney(Number number,
                                 CurrencyUnit currency,
                                 MathContext mathContext)
```
    Deprecated.
  - RoundedMoney
```
@Deprecated
public RoundedMoney(Number number,
                                 CurrencyUnit currency,
                                 MonetaryContext context,
                                 MonetaryOperator rounding)
```
    Deprecated.
- Method Detail
  - of
```
public static RoundedMoney of(BigDecimal number,
                              CurrencyUnit currency)
```
    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(BigDecimal number,
                              CurrencyUnit currency,
                              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(BigDecimal number,
                              CurrencyUnit currency,
                              MathContext mathContext)
```
    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.
    
    Returns:
    
    a Money combining the numeric value and currency unit.
  - of
```
@Deprecated
public static RoundedMoney of(Number number,
                                           CurrencyUnit currency)
```
    Deprecated.
    
    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(Number number,
                              CurrencyUnit currency,
                              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(Number number,
                              CurrencyUnit currency,
                              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
```
@Deprecated
public static RoundedMoney of(CurrencyUnit currency,
                                           Number number,
                                           MonetaryContext monetaryContext,
                                           MonetaryOperator rounding)
```
    Deprecated.
    
    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
```
@Deprecated
public static RoundedMoney of(Number number,
                                           String currencyCode)
```
    Deprecated.
    
    Static factory method for creating a new instance of RoundedMoney .
    
    Parameters:
    
    currencyCode - The target currency as ISO currency code.
    
    number - The numeric part, not null.
    
    Returns:
    
    A new instance of RoundedMoney.
  - of
```
public static RoundedMoney of(Number number,
                              String currencyCode,
                              MonetaryOperator rounding)
```
    Static factory method for creating a new instance of RoundedMoney .
    
    Parameters:
    
    currencyCode - 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
```
@Deprecated
public static RoundedMoney of(Number number,
                                           String currencyCode,
                                           MonetaryContext monetaryContext)
```
    Deprecated.
    
    Static factory method for creating a new instance of RoundedMoney .
    
    Parameters:
    
    currencyCode - 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,
                              MonetaryContext monetaryContext,
                              MonetaryOperator rounding)
```
    Static factory method for creating a new instance of RoundedMoney .
    
    Parameters:
    
    currencyCode - 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.
  - zero
```
public static RoundedMoney zero(CurrencyUnit currency)
```
    Obtains an instance of RoundedMoney representing zero.
    
    Parameters:
    
    currency - the currency, not null.
    
    Returns:
    
    an instance of RoundedMoney representing zero.
    
    Since:
    
    1.0.1
  - ofMinor
```
public static RoundedMoney ofMinor(CurrencyUnit currency,
                                   long amountMinor)
```
    Obtains an instance of FastMoney from an amount in minor units. For example, ofMinor(USD, 1234) creates the instance USD 12.34.
    
    Parameters:
    
    currency - the currency, not null
    
    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 RoundedMoney 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(), Money.ofMinor(CurrencyUnit, long, int)
  - getCurrency
```
public CurrencyUnit getCurrency()
```
    Specified by:
    
    getCurrency in interface CurrencySupplier
  - getContext
```
public MonetaryContext getContext()
```
    Access the MathContext used by this instance.
    
    Specified by:
    
    getContext in interface MonetaryAmount
    
    Returns:
    
    the MathContext used, never null.
  - abs
```
public RoundedMoney abs()
```
    Specified by:
    
    abs in interface MonetaryAmount
  - add
```
public RoundedMoney add(MonetaryAmount amount)
```
    Specified by:
    
    add in interface MonetaryAmount
  - divide
```
public RoundedMoney divide(Number divisor)
```
    Specified by:
    
    divide in interface MonetaryAmount
  - divideAndRemainder
```
public RoundedMoney[] divideAndRemainder(Number divisor)
```
    Specified by:
    
    divideAndRemainder in interface MonetaryAmount
  - divideToIntegralValue
```
public RoundedMoney divideToIntegralValue(Number divisor)
```
    Specified by:
    
    divideToIntegralValue in interface MonetaryAmount
  - multiply
```
public RoundedMoney multiply(Number multiplicand)
```
    Specified by:
    
    multiply in interface MonetaryAmount
  - negate
```
public RoundedMoney negate()
```
    Specified by:
    
    negate in interface MonetaryAmount
  - plus
```
public RoundedMoney plus()
```
    Specified by:
    
    plus in interface MonetaryAmount
  - subtract
```
public RoundedMoney subtract(MonetaryAmount subtrahend)
```
    Specified by:
    
    subtract in interface MonetaryAmount
  - pow
```
public RoundedMoney pow(int n)
```
  - ulp
```
public RoundedMoney ulp()
```
  - remainder
```
public RoundedMoney remainder(Number divisor)
```
    Specified by:
    
    remainder in interface MonetaryAmount
  - scaleByPowerOfTen
```
public RoundedMoney scaleByPowerOfTen(int n)
```
    Specified by:
    
    scaleByPowerOfTen 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
  - with
```
public RoundedMoney with(Number amount)
```
  - with
```
public RoundedMoney with(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(CurrencyUnit currency,
                         Number amount)
```
  - getScale
```
public int getScale()
```
  - getPrecision
```
public int getPrecision()
```
  - 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
  - isNotEqualTo
```
public boolean isNotEqualTo(MonetaryAmount amount)
```
  - with
```
public RoundedMoney with(MonetaryOperator operator)
```
    Specified by:
    
    with in interface MonetaryAmount
  - from
```
public static RoundedMoney from(MonetaryAmount amt)
```
  - parse
```
public static RoundedMoney parse(CharSequence text)
```
    Obtains an instance of RoundedMoney from a text string such as 'EUR 25.25'.
    
    Parameters:
    
    text - the input text, not null.
    
    Returns:
    
    RoundedMoney instance
    
    Throws:
    
    NumberFormatException - if the amount is not a number
    
    UnknownCurrencyException - if the currency is not resolvable
  - parse
```
public static RoundedMoney parse(CharSequence text,
                                 MonetaryAmountFormat formatter)
```
    Obtains an instance of FastMoney from a text using specific formatter.
    
    Parameters:
    
    text - the text to parse not null
    
    formatter - the formatter to use not null
    
    Returns:
    
    RoundedMoney instance
  - query
```
public <T> T query(MonetaryQuery<T> query)
```
    Specified by:
    
    query in interface MonetaryAmount
  - asType
```
@Deprecated
public <T> T asType(Class<T> type)
```
    Deprecated.
  - asType
```
@Deprecated
public <T> T asType(Class<T> type,
                                 MonetaryOperator adjuster)
```
    Deprecated.
  - 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(MonetaryAmount o)
```
    Specified by:
    
    compareTo in interface Comparable<MonetaryAmount>
  - getNumber
```
public NumberValue getNumber()
```
    Specified by:
    
    getNumber in interface 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 multiplicand)
```
    Specified by:
    
    multiply in interface MonetaryAmount
  - multiply
```
public RoundedMoney multiply(double multiplicand)
```
    Specified by:
    
    multiply in interface MonetaryAmount
  - divide
```
public RoundedMoney divide(long divisor)
```
    Specified by:
    
    divide in interface MonetaryAmount
  - divide
```
public RoundedMoney divide(double divisor)
```
    Specified by:
    
    divide in interface MonetaryAmount
  - remainder
```
public RoundedMoney remainder(long divisor)
```
    Specified by:
    
    remainder in interface MonetaryAmount
  - remainder
```
public RoundedMoney remainder(double divisor)
```
    Specified by:
    
    remainder in interface MonetaryAmount
  - divideAndRemainder
```
public RoundedMoney[] divideAndRemainder(long divisor)
```
    Specified by:
    
    divideAndRemainder in interface MonetaryAmount
  - divideAndRemainder
```
public RoundedMoney[] divideAndRemainder(double divisor)
```
    Specified by:
    
    divideAndRemainder in interface MonetaryAmount
  - stripTrailingZeros
```
public RoundedMoney stripTrailingZeros()
```
    Specified by:
    
    stripTrailingZeros in interface MonetaryAmount
  - divideToIntegralValue
```
public RoundedMoney divideToIntegralValue(long divisor)
```
    Specified by:
    
    divideToIntegralValue in interface MonetaryAmount
  - divideToIntegralValue
```
public RoundedMoney divideToIntegralValue(double divisor)
```
    Specified by:
    
    divideToIntegralValue in interface MonetaryAmount
  - getFactory
```
public MonetaryAmountFactory<RoundedMoney> getFactory()
```
    Specified by:
    
    getFactory in interface MonetaryAmount

Class RoundedMoney

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MONETARY_ROUNDING_KEY

DEFAULT_MONETARY_CONTEXT

Constructor Detail

RoundedMoney

RoundedMoney

RoundedMoney

Method Detail

of

of

of

of

of

of

of

of

of

of

of

zero

ofMinor

ofMinor

getCurrency

getContext

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

parse

parse

query

asType

asType

toString

hashCode

equals

compareTo

getNumber

asNumberStripped

multiply

multiply

divide

divide

remainder

remainder

divideAndRemainder

divideAndRemainder