Module com.aoapps.lang

Package com.aoapps.lang.i18n

Class Money

java.lang.Object

com.aoapps.lang.i18n.Money

All Implemented Interfaces:

FastExternalizable, Externalizable, Serializable, Comparable<Money>

public final class Money
extends Object
implements FastExternalizable, Comparable<Money>

Stores a monetary value as a combination of currency and amount. It supports many of the basic operators from BigDecimal, and more will be added as needed. An ArithmeticException on any attempt to perform operations on monetary values of different currencies.

Author:

AO Industries, Inc.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Money()	Deprecated. Only required for implementation, do not use directly.
Money(Currency currency, long value, int scale)
Money(Currency currency, BigDecimal value)	Will change the scale of the value to match the currency, but will not round.

Method Summary

Modifier and Type	Method	Description
Money	add(Money addend)
int	compareTo(Money other)	Sorts by currency code and then value.
boolean	equals(Object o)	Equal when has same currency, value, and scale.
Currency	getCurrency()
int	getScale()	Gets the scale of this currency.
long	getSerialVersionUID()	Gets the serialVersionUID for this object.
long	getUnscaledValue()	Gets the unscaled value of this currency.
BigDecimal	getValue()
int	hashCode()
Money	multiply(BigDecimal multiplicand)	Multiplies without rounding.
Money	multiply(BigDecimal multiplicand, RoundingMode roundingMode)	Multiplies with rounding.
Money	negate()	Returns a monetary amount that is the negative of this amount.
static Money	parseMoney(Currency currency, Locale locale, String value)
static BigDecimal	parseMoneyAmount(Locale locale, String symbol, String value)	Parses a monetary amount with an optional symbol prefix.
void	readExternal(ObjectInput in)
Money	subtract(Money subtrahend)
String	toString()	Displays the monetary value as currency symbol (in Locale-specific display) either proceeding or following the value, such as "$100.00", "Can$-100.50", "100,00 $ CA" (with non-breaking spaces).
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Money

public Money(Currency currency,
             BigDecimal value)
      throws NumberFormatException

Will change the scale of the value to match the currency, but will not round.

Throws:

NumberFormatException - if unable to scale the value.

Money

public Money(Currency currency,
             long value,
             int scale)
      throws NumberFormatException

Throws:

NumberFormatException

Money

@Deprecated
public Money()

Deprecated.

Only required for implementation, do not use directly.

See Also:

FastExternalizable

Method Detail

parseMoneyAmount

public static BigDecimal parseMoneyAmount(Locale locale,
                                          String symbol,
                                          String value)
                                   throws NumberFormatException

Parses a monetary amount with an optional symbol prefix. Trims, strips the prefix, trims, removes any commas.

TODO: A future version should be more locale-aware regarding assumption comma is used for group separator.

Parameters:

symbol - The optional currency prefix to strip (see CurrencyUtil.getSymbol(java.util.Currency, java.util.Locale))

value - The value to parse

Returns:

The monetary amount or null if empty

Throws:

NumberFormatException - when not a value amount after filtering

parseMoney

public static Money parseMoney(Currency currency,
                               Locale locale,
                               String value)

See Also:

parseMoneyAmount(java.util.Locale, java.lang.String, java.lang.String)

equals

public boolean equals(Object o)

Equal when has same currency, value, and scale.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Money other)

Sorts by currency code and then value.

Specified by:

compareTo in interface Comparable<Money>

See Also:

CurrencyComparator

getCurrency

public Currency getCurrency()

getValue

public BigDecimal getValue()

getUnscaledValue

public long getUnscaledValue()

Gets the unscaled value of this currency.

getScale

public int getScale()

Gets the scale of this currency.

toString

public String toString()

Displays the monetary value as currency symbol (in Locale-specific display) either proceeding or following the value, such as "$100.00", "Can$-100.50", "100,00 $ CA" (with non-breaking spaces).

Overrides:

toString in class Object

See Also:

CurrencyUtil.getSymbol(java.util.Currency, java.util.Locale), ThreadLocale

add

public Money add(Money addend)
          throws ArithmeticException

Throws:

ArithmeticException

multiply

public Money multiply(BigDecimal multiplicand)
               throws ArithmeticException

Multiplies without rounding.

Throws:

ArithmeticException

multiply

public Money multiply(BigDecimal multiplicand,
                      RoundingMode roundingMode)
               throws ArithmeticException

Multiplies with rounding.

Throws:

ArithmeticException

negate

public Money negate()

Returns a monetary amount that is the negative of this amount.

subtract

public Money subtract(Money subtrahend)
               throws ArithmeticException

Throws:

ArithmeticException

getSerialVersionUID

public long getSerialVersionUID()

Description copied from interface: FastExternalizable

Gets the serialVersionUID for this object. Since FastExternalizable-aware containers are not special JVM constructs, they do not have access to the private and protected fields. It is assumed that two separate instances of the same class will always return the same serialVersionUID.

Specified by:

getSerialVersionUID in interface FastExternalizable

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException