Package com.storedobject.core

Class Money

java.lang.Object

com.storedobject.core.Money

All Implemented Interfaces:

BigValue, Storable, Comparable<Money>

public final class Money
extends Object
implements Storable, Comparable<Money>, BigValue

Class that represents a monetary value. This class is immutable.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Money.List	A class representing a list of currency values.

Constructor Summary

Constructors

Constructor	Description
Money()	Create a monetary value of zero in the default currency.
Money(double value, String currencyCode)	Create a monetary value from the amount specified in a particular currency.
Money(double value, Currency currency)	Create a monetary value from the amount specified in a particular currency.
Money(Number value)	Create a monetary value from the amount specified in the default currency.
Money(Number amount, String currencyCode)	Create a monetary value from the amount specified in a particular currency.
Money(Number value, Currency currency)	Create a monetary value from the amount specified in a particular currency.
Money(String currencyCode)	Create a monetary value of zero in a particular currency.
Money(String amount, String currencyCode)	Create a monetary value from the amount specified in a particular currency.
Money(String amount, Currency currency)	Create a monetary value from the amount specified in a particular currency.
Money(BigDecimal value)	Create a monetary value from the amount specified in the default currency.
Money(BigDecimal amount, String currencyCode)	Create a monetary value from the amount specified in a particular currency.
Money(BigDecimal value, Currency currency)	Create a monetary value from the amount specified in a particular currency.
Money(Currency currency)	Create a monetary value of zero in a particular currency.

Method Summary

Modifier and Type	Method	Description
Money	absolute()	Return the monetary value containing the absolute value.
Money	add(Money amount)	Add amount
Money	add(String amount)	Add amount value
Money	add(BigDecimal amount)	Add amount
Money	buy(Date date, Currency currency)	Convert this monetary value to another currency by applying the buying rate.
Money	buy(Currency currency)	Convert this monetary value to another currency by applying the buying rate.
Money	buy(Currency currency, CurrencyRateProvider rateProvider)	Convert this monetary value to another currency by applying the buying rate.
int	compareTo(Money money)
Money	convert(Date date, Currency currency)	Convert this monetary value to another currency (by multiplying with the average rate).
Money	convert(Currency currency)	Convert this monetary value to another currency (by multiplying with the average rate).
Money	convert(Currency currency, CurrencyRateProvider rateProvider)	Convert this monetary value to another currency (by multiplying with the average rate).
static Money	create(Object value)	Construct a monetary value from a string representation.
static List<Currency>	currencies()
static List<Currency>	currencies(boolean includeMetals)
Money	divide(double divisor)	Divide the amount with a value
Money	divide(double divisor, Currency currency)	Divide the amount with a rate and convert it to another currency.
Money	divide(DecimalNumber divisor)	Divide the amount with a rate
Money	divide(DecimalNumber divisor, Currency currency)	Divide the amount with a rate and convert it to another currency.
Money	divide(Quantity quantity)	Divide the amount with a quantity (To find the unit price)
Money	divide(BigDecimal divisor)	Divide the amount with a rate.
Money	divide(BigDecimal divisor, Currency currency)	Divide the amount with a rate and convert it to another currency.
boolean	equals(Object another)
Rate	getBuyingRate(Date date, Currency currency)	Gets the selling rate.
static Rate	getBuyingRate(Date date, Currency currency, SystemEntity systemEntity)	Gets the buying rate.
static Rate	getBuyingRate(Date date, Currency from, Currency to)	Gets the selling rate.
Rate	getBuyingRate(Currency currency)	Gets the selling rate.
static Rate	getBuyingRate(Currency currency, SystemEntity systemEntity)	Gets the buying rate.
static Rate	getBuyingRate(Currency from, Currency to)	Gets the selling rate.
Currency	getCurrency()	Get the currency of this monetary value.
static Currency	getCurrency(String code)	Get currency for the given code.
static Currency	getCurrency(String code, boolean includeMetals)	Get currency for the given code.
int	getDecimals()	Gets the number of decimals.
static Currency	getDefaultCurrency()	Get the default currency.
Rate	getExchangeRate(Date date, Currency currency)	Gets the exchange rate (average of selling rate and buying rate).
Rate	getExchangeRate(Date date, Currency currency, SystemEntity systemEntity)	Gets the exchange rate (average of selling rate and buying rate).
static Rate	getExchangeRate(Date date, Currency from, Currency to)	Gets the exchange rate (average of selling rate and buying rate).
Rate	getExchangeRate(Currency currency)	Gets the exchange rate (average of selling rate and buying rate).
Rate	getExchangeRate(Currency currency, SystemEntity systemEntity)	Gets the exchange rate (average of selling rate and buying rate).
static Rate	getExchangeRate(Currency from, Currency to)	Gets the exchange rate (average of selling rate and buying rate).
int	getFractionDigits()
static int	getFractionDigits(Currency currency)
Rate	getSellingRate(Date date, Currency currency)	Gets the selling rate.
static Rate	getSellingRate(Date date, Currency currency, SystemEntity systemEntity)	Gets the selling rate.
static Rate	getSellingRate(Date date, Currency from, Currency to)	Gets the selling rate.
Rate	getSellingRate(Currency currency)	Gets the selling rate.
static Rate	getSellingRate(Currency currency, SystemEntity systemEntity)	Gets the selling rate.
static Rate	getSellingRate(Currency from, Currency to)	Gets the selling rate.
String	getStorableValue()	Get the storable value.
static String	getSymbol(Currency currency)	Get the symbol for the given currency.
BigDecimal	getValue()	Get the monetary value as BigDecimal.
int	hashCode()
boolean	isCredit()	Checks if this is a credit amount or not.
boolean	isDebit()	Checks if this is a debit amount or not.
boolean	isGreaterThan(long value)	Check if this is greater than 'value'.
boolean	isGreaterThan(Money another)	Check if this is greater than 'another'.
boolean	isGreaterThanOrEqual(long value)	Check if this is greater than or equal to 'value'.
boolean	isGreaterThanOrEqual(Money another)	Check if this is greater than or equal to 'another'.
boolean	isLessThan(long value)	Check if this is less than 'value'.
boolean	isLessThan(Money another)	Check if this is less than 'another'.
boolean	isLessThanOrEqual(long value)	Check if this is less than or equal to 'value'.
boolean	isLessThanOrEqual(Money another)	Check if this is less than or equal to 'another'.
static boolean	isMetal(Currency currency)
static boolean	isMultiCurrency()	Is the platform running in a multi-currency (and multi-tenancy) environment?
boolean	isNegative()
boolean	isPositive()	Checks if this is a positive amount or not.
boolean	isZero()	Checks if this is zero or not.
Money	multiply(double multiplicand)	Multiply the amount with a value
Money	multiply(double multiplicand, Currency currency)	Multiply the amount with a value and convert to another currency.
Money	multiply(DecimalNumber multiplicand)	Multiply the amount with a rate
Money	multiply(DecimalNumber multiplicand, Currency currency)	Multiply the amount with a rate and convert to another currency.
Money	multiply(Quantity quantity)	Multiply the amount with a quantity (Given the unit price, find out the total amount).
Money	multiply(BigDecimal multiplicand)	Multiply the amount with a value
Money	multiply(BigDecimal multiplicand, Currency currency)	Multiply the amount with a rate and convert to another currency.
Money	negate()	Reverses the sign of this money.
Money	percentage(double percentage)	Calculate the percentage.
Money	percentage(DecimalNumber percentage)	Calculate the percentage.
Money	percentage(Rate percentage)	Calculate the percentage.
Money	percentage(BigDecimal percentage)	Calculate the percentage.
Money	round()	Round the amount to the lower/upper value.
Money	roundDown()	Round the amount to the lower value.
Money	roundUp()	Round the amount to the upper value.
Money	sell(Date date, Currency currency)	Convert this monetary value to another currency by applying the selling rate.
Money	sell(Currency currency)	Convert this monetary value to another currency by applying the selling rate.
Money	sell(Currency currency, CurrencyRateProvider rateProvider)	Convert this monetary value to another currency by applying the selling rate.
Money	subtract(Money amount)	Subtract amount
Money	subtract(String amount)	Subtract amount
Money	subtract(BigDecimal amount)	Subtract amount
Money	toLocal(Rate exchangeRate, SystemEntity systemEntity)	Convert this monetary value to the equivalent in local currency by multiplying with the given "exchange rate".
Money	toLocal(Rate exchangeRate, TransactionManager tm)	Convert this monetary value to the equivalent in local currency by multiplying with the given "exchange rate".
Money	toLocal(SystemEntity systemEntity)	Convert this monetary value to the equivalent in local currency by multiplying with the given "exchange rate".
Money	toLocal(TransactionManager tm)	Convert this monetary value to the equivalent in local currency by multiplying with the given "exchange rate".
Money	toLocal(Date date, SystemEntity systemEntity)	Convert this monetary value to the equivalent in local currency by multiplying with the given "exchange rate".
Money	toLocal(Date date, TransactionManager tm)	Convert this monetary value to the equivalent in local currency by multiplying with the given "exchange rate".
String	toString()	Create the formatted representation of the amount value with appropriate decimals places.
String	toString(boolean showSymbol)	Create the formatted representation of the amount value with appropriate decimals places.
String	toString(boolean showSymbol, boolean tagDebit)	Create the formatted representation of the amount value with appropriate decimals places.
String	toString(boolean showSymbol, boolean tagDebit, SystemUser forUser)	Create the formatted representation of the amount value with appropriate decimals places.
String	toString(boolean showSymbol, SystemUser forUser)	Create the formatted representation of the amount value with appropriate decimals places.
String	toString(SystemUser forUser)	Create the formatted representation of the amount value with appropriate decimals places.
boolean	wasRounded()	Whether a rounding took place when this was created or not.
String	words()	Get the currency amount in words.
String	words(boolean camelCase)	Get the currency amount in words.
String	words(SystemUser forUser)	Get the currency amount in words.
String	words(SystemUser forUser, boolean camelCase)	Get the currency amount in words.
Money	zero()	Set the monetary value to zero.

Methods inherited from class java.lang.Object

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

Constructor Details

Money

public Money()

Create a monetary value of zero in the default currency.

Money

public Money(String currencyCode)

Create a monetary value of zero in a particular currency.

Parameters:

currencyCode - The currency code (ISO standard)

Money

public Money(String amount,
 String currencyCode)

Create a monetary value from the amount specified in a particular currency.

Parameters:

amount - The amount

currencyCode - The currency code (ISO standard)

Money

public Money(BigDecimal amount,
 String currencyCode)

Create a monetary value from the amount specified in a particular currency.

Parameters:

amount - The amount

currencyCode - The currency code (ISO standard)

Money

public Money(Currency currency)

Create a monetary value of zero in a particular currency.

Parameters:

currency - Currency

Money

public Money(String amount,
 Currency currency)

Create a monetary value from the amount specified in a particular currency.

Parameters:

amount - The amount

currency - Currency

Money

public Money(BigDecimal value,
 Currency currency)

Create a monetary value from the amount specified in a particular currency.

Parameters:

value - The BigDecimal value.

currency - Currency

Money

public Money(double value,
 Currency currency)

Create a monetary value from the amount specified in a particular currency.

Parameters:

value - The money value. The value will be rounded (half-way up) if required.

currency - Currency

Money

public Money(double value,
 String currencyCode)

Create a monetary value from the amount specified in a particular currency.

Parameters:

value - The money value. The value will be rounded (half-way up) if required.

currencyCode - The currency code (ISO standard)

Money

public Money(Number amount,
 String currencyCode)

Create a monetary value from the amount specified in a particular currency.

Parameters:

amount - The amount

currencyCode - The currency code (ISO standard)

Money

public Money(Number value,
 Currency currency)

Create a monetary value from the amount specified in a particular currency.

Parameters:

value - The amount.

currency - Currency

Money

public Money(BigDecimal value)

Create a monetary value from the amount specified in the default currency.

Parameters:

value - The amount.

Money

public Money(Number value)

Create a monetary value from the amount specified in the default currency.

Parameters:

value - The amount.

Method Details

getDefaultCurrency

public static Currency getDefaultCurrency()

Get the default currency. If this is invoked in a multi-currency environment, a runtime exception will be thrown.

Returns:

Default currency.

isMultiCurrency

public static boolean isMultiCurrency()

Is the platform running in a multi-currency (and multi-tenancy) environment? A multi-currency environment is an environment where multiple system entities exist and not all of them have the same accounting currency.

Returns:

True/false.

create

public static Money create(Object value)

Construct a monetary value from a string representation.

Parameters:

value - An object whose toString() representation provides (amount,currency code). Example: (145.45,USD), (17.50,IRS).

Returns:

Money

getCurrency

public static Currency getCurrency(String code)

Get currency for the given code.

Parameters:

code - Currency code.

Returns:

Currency or null if the code is invalid.

getCurrency

public static Currency getCurrency(String code,
 boolean includeMetals)

Get currency for the given code.

Parameters:

code - Currency code.

Returns:

Currency or null if the code is invalid.

getDecimals

public int getDecimals()

Gets the number of decimals.

Returns:

Number of decimals

getValue

public BigDecimal getValue()

Get the monetary value as BigDecimal.

Specified by:

getValue in interface BigValue

Returns:

The value.

getCurrency

public Currency getCurrency()

Get the currency of this monetary value.

Returns:

Currency.

zero

public Money zero()

Set the monetary value to zero.

Returns:

Zeroed monetary value.

add

public Money add(String amount)

Add amount value

Parameters:

amount - The amount value to add

Returns:

Result

add

public Money add(BigDecimal amount)

Add amount

Parameters:

amount - The amount value to add

Returns:

Result

add

public Money add(Money amount)

Add amount

Parameters:

amount - The amount value to add

Returns:

Result

getBuyingRate

public Rate getBuyingRate(Currency currency)

Gets the selling rate.

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

currency - Currency for which rate is required.

Returns:

Rate

getBuyingRate

public Rate getBuyingRate(Date date,
 Currency currency)

Gets the selling rate.

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

date - Effective date.

currency - Currency for which rate is required.

Returns:

Rate

getSellingRate

public Rate getSellingRate(Currency currency)

Gets the selling rate.

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

currency - Currency for which rate is required.

Returns:

Rate

getSellingRate

public Rate getSellingRate(Date date,
 Currency currency)

Gets the selling rate.

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

date - Effective date.

currency - Currency for which rate is required.

Returns:

Rate

getExchangeRate

public Rate getExchangeRate(Currency currency)

Gets the exchange rate (average of selling rate and buying rate).

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

currency - Currency for which rate is required.

Returns:

Rate

getExchangeRate

public Rate getExchangeRate(Date date,
 Currency currency)

Gets the exchange rate (average of selling rate and buying rate).

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

date - Effective date.

currency - Currency for which rate is required.

Returns:

Rate

getBuyingRate

public static Rate getBuyingRate(Currency currency,
 SystemEntity systemEntity)

Gets the buying rate.

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

currency - Currency for which rate is required.

systemEntity - System Entity.

Returns:

Rate

getBuyingRate

public static Rate getBuyingRate(Date date,
 Currency currency,
 SystemEntity systemEntity)

Gets the buying rate.

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

date - Effective date.

currency - Currency for which rate is required.

systemEntity - System Entity.

Returns:

Rate

getSellingRate

public static Rate getSellingRate(Currency currency,
 SystemEntity systemEntity)

Gets the selling rate.

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

currency - Currency for which rate is required.

systemEntity - System Entity.

Returns:

Rate

getSellingRate

public static Rate getSellingRate(Date date,
 Currency currency,
 SystemEntity systemEntity)

Gets the selling rate.

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

date - Effective date.

currency - Currency for which rate is required.

systemEntity - System Entity.

Returns:

Rate

getExchangeRate

public Rate getExchangeRate(Currency currency,
 SystemEntity systemEntity)

Gets the exchange rate (average of selling rate and buying rate).

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

currency - Currency for which rate is required.

systemEntity - System Entity.

Returns:

Rate

getExchangeRate

public Rate getExchangeRate(Date date,
 Currency currency,
 SystemEntity systemEntity)

Gets the exchange rate (average of selling rate and buying rate).

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

date - Effective date.

currency - Currency for which rate is required.

systemEntity - System Entity.

Returns:

Rate

getBuyingRate

public static Rate getBuyingRate(Currency from,
 Currency to)

Gets the selling rate.

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

from - Currency for which rate is required.

to - Target currency to convert to.

Returns:

Rate

getBuyingRate

public static Rate getBuyingRate(Date date,
 Currency from,
 Currency to)

Gets the selling rate.

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

date - Effective date.

from - Currency for which rate is required.

to - Target currency to convert to.

Returns:

Rate

getSellingRate

public static Rate getSellingRate(Currency from,
 Currency to)

Gets the selling rate.

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

from - Currency for which rate is required.

to - Target currency to convert to.

Returns:

Rate

getSellingRate

public static Rate getSellingRate(Date date,
 Currency from,
 Currency to)

Gets the selling rate.

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

date - Effective date.

from - Currency for which rate is required.

to - Target currency to convert to.

Returns:

Rate

getExchangeRate

public static Rate getExchangeRate(Currency from,
 Currency to)

Gets the exchange rate (average of selling rate and buying rate).

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

from - Currency for which rate is required.

to - Target currency to convert to.

Returns:

Rate

getExchangeRate

public static Rate getExchangeRate(Date date,
 Currency from,
 Currency to)

Gets the exchange rate (average of selling rate and buying rate).

Note: To convert to the target currency, you need to divide the monetary value with this rate.

Parameters:

date - Effective date.

from - Currency for which rate is required.

to - Target currency to convert to.

Returns:

Rate

convert

public Money convert(Currency currency,
 CurrencyRateProvider rateProvider)

Convert this monetary value to another currency (by multiplying with the average rate).

Parameters:

currency - Currency to convert to.

rateProvider - Currency rate provider.

Returns:

Converted monetary value.

convert

public Money convert(Currency currency)

Convert this monetary value to another currency (by multiplying with the average rate).

Parameters:

currency - Currency to convert to.

Returns:

Converted monetary value.

convert

public Money convert(Date date,
 Currency currency)

Convert this monetary value to another currency (by multiplying with the average rate).

Parameters:

date - Effective date.

currency - Currency to convert to.

Returns:

Converted monetary value.

buy

public Money buy(Currency currency,
 CurrencyRateProvider rateProvider)

Convert this monetary value to another currency by applying the buying rate.

Parameters:

currency - Currency to convert to.

rateProvider - Currency rate provider.

Returns:

Converted monetary value.

buy

public Money buy(Currency currency)

Convert this monetary value to another currency by applying the buying rate.

Parameters:

currency - Currency to convert to.

Returns:

Converted monetary value.

buy

public Money buy(Date date,
 Currency currency)

Convert this monetary value to another currency by applying the buying rate.

Parameters:

date - Effective date.

currency - Currency to convert to.

Returns:

Converted monetary value.

sell

public Money sell(Currency currency,
 CurrencyRateProvider rateProvider)

Convert this monetary value to another currency by applying the selling rate.

Parameters:

currency - Currency to convert to.

rateProvider - Currency rate provider.

Returns:

Converted monetary value.

sell

public Money sell(Currency currency)

Convert this monetary value to another currency by applying the selling rate.

Parameters:

currency - Currency to convert to.

Returns:

Converted monetary value.

sell

public Money sell(Date date,
 Currency currency)

Convert this monetary value to another currency by applying the selling rate.

Parameters:

date - Effective date.

currency - Currency to convert to.

Returns:

Converted monetary value.

subtract

public Money subtract(String amount)

Subtract amount

Parameters:

amount - The amount value to subtract

Returns:

Result

subtract

public Money subtract(BigDecimal amount)

Subtract amount

Parameters:

amount - The amount value to subtract

Returns:

Result

subtract

public Money subtract(Money amount)

Subtract amount

Parameters:

amount - The amount value to subtract

Returns:

Result

multiply

public Money multiply(Quantity quantity)

Multiply the amount with a quantity (Given the unit price, find out the total amount).

Parameters:

quantity - Quantity

Returns:

Result

multiply

public Money multiply(double multiplicand)

Multiply the amount with a value

Parameters:

multiplicand - Multiplicand

Returns:

Result

multiply

public Money multiply(double multiplicand,
 Currency currency)

Multiply the amount with a value and convert to another currency.

Parameters:

multiplicand - Multiplicand

Returns:

Result

multiply

public Money multiply(BigDecimal multiplicand)

Multiply the amount with a value

Parameters:

multiplicand - Multiplicand

Returns:

Result

multiply

public Money multiply(BigDecimal multiplicand,
 Currency currency)

Multiply the amount with a rate and convert to another currency.

Parameters:

multiplicand - Multiplicand

currency - Currency to convert to.

Returns:

Result

multiply

public Money multiply(DecimalNumber multiplicand)

Multiply the amount with a rate

Parameters:

multiplicand - Multiplicand

Returns:

Result

multiply

public Money multiply(DecimalNumber multiplicand,
 Currency currency)

Multiply the amount with a rate and convert to another currency.

Parameters:

multiplicand - Multiplicand

currency - Currency to convert to.

Returns:

Result

toLocal

public Money toLocal(Rate exchangeRate,
 TransactionManager tm)

Convert this monetary value to the equivalent in local currency by multiplying with the given "exchange rate".

Parameters:

exchangeRate - Exchange rate

tm - Transaction manager (Local currency will be determined from this)

Returns:

Result

toLocal

public Money toLocal(Rate exchangeRate,
 SystemEntity systemEntity)

Convert this monetary value to the equivalent in local currency by multiplying with the given "exchange rate".

Parameters:

exchangeRate - Exchange rate

systemEntity - System entity (Local currency will be determined from this)

Returns:

Result

toLocal

public Money toLocal(TransactionManager tm)

Convert this monetary value to the equivalent in local currency by multiplying with the given "exchange rate".

Parameters:

tm - Transaction manager (Local currency will be determined from this)

Returns:

Result

toLocal

public Money toLocal(Date date,
 TransactionManager tm)

Convert this monetary value to the equivalent in local currency by multiplying with the given "exchange rate".

Parameters:

date - Effective date.

tm - Transaction manager (Local currency will be determined from this)

Returns:

Result

toLocal

public Money toLocal(SystemEntity systemEntity)

Convert this monetary value to the equivalent in local currency by multiplying with the given "exchange rate".

Parameters:

systemEntity - System entity (Local currency will be determined from this)

Returns:

Result

toLocal

public Money toLocal(Date date,
 SystemEntity systemEntity)

Convert this monetary value to the equivalent in local currency by multiplying with the given "exchange rate".

Parameters:

date - Effective date.

systemEntity - System entity (Local currency will be determined from this)

Returns:

Result

percentage

public Money percentage(double percentage)

Calculate the percentage.

Parameters:

percentage - Percentage

Returns:

Result

percentage

public Money percentage(BigDecimal percentage)

Calculate the percentage.

Parameters:

percentage - Percentage

Returns:

Result

percentage

public Money percentage(DecimalNumber percentage)

Calculate the percentage.

Parameters:

percentage - Percentage

Returns:

Result

percentage

public Money percentage(Rate percentage)

Calculate the percentage.

Parameters:

percentage - Percentage

Returns:

Result

divide

public Money divide(double divisor)

Divide the amount with a value

Parameters:

divisor - Divisor

Returns:

Result

divide

public Money divide(double divisor,
 Currency currency)

Divide the amount with a rate and convert it to another currency.

Parameters:

divisor - Divisor

currency - Currency to convert to.

Returns:

Result

divide

public Money divide(BigDecimal divisor)

Divide the amount with a rate.

Parameters:

divisor - Divisor

Returns:

Result

divide

public Money divide(BigDecimal divisor,
 Currency currency)

Divide the amount with a rate and convert it to another currency.

Parameters:

divisor - Divisor

currency - Currency to convert to.

Returns:

Result

divide

public Money divide(DecimalNumber divisor)

Divide the amount with a rate

Parameters:

divisor - Divisor

Returns:

Result

divide

public Money divide(DecimalNumber divisor,
 Currency currency)

Divide the amount with a rate and convert it to another currency.

Parameters:

divisor - Divisor

currency - Currency to convert to.

Returns:

Result

divide

public Money divide(Quantity quantity)

Divide the amount with a quantity (To find the unit price)

Parameters:

quantity - Quantity

Returns:

Result

negate

public Money negate()

Reverses the sign of this money.

Returns:

Negated value

absolute

public Money absolute()

Return the monetary value containing the absolute value.

Returns:

Absolute value

round

public Money round()

Round the amount to the lower/upper value. If the decimal part is greater than or equal to 0.5, it will be rounded up, otherwise, it will be rounded down.

Returns:

Rounded value.

roundUp

public Money roundUp()

Round the amount to the upper value.

Returns:

Rounded value.

roundDown

public Money roundDown()

Round the amount to the lower value.

Returns:

Rounded value.

equals

public boolean equals(Object another)

Overrides:

equals in class Object

isGreaterThan

public boolean isGreaterThan(Money another)

Check if this is greater than 'another'.

Parameters:

another - Value to compare.

Returns:

True if this is greater.

isGreaterThan

public boolean isGreaterThan(long value)

Check if this is greater than 'value'.

Parameters:

value - Value to compare.

Returns:

True if this is greater.

isLessThan

public boolean isLessThan(Money another)

Check if this is less than 'another'.

Parameters:

another - Value to compare.

Returns:

True if this is less.

isLessThan

public boolean isLessThan(long value)

Check if this is less than 'value'.

Parameters:

value - Value to compare.

Returns:

True if this is less.

isGreaterThanOrEqual

public boolean isGreaterThanOrEqual(Money another)

Check if this is greater than or equal to 'another'.

Parameters:

another - Value to compare.

Returns:

True if this is greater than or equal.

isGreaterThanOrEqual

public boolean isGreaterThanOrEqual(long value)

Check if this is greater than or equal to 'value'.

Parameters:

value - Value to compare.

Returns:

True if this is greater or equal.

isLessThanOrEqual

public boolean isLessThanOrEqual(Money another)

Check if this is less than or equal to 'another'.

Parameters:

another - Value to compare.

Returns:

True if this is less than or equal.

isLessThanOrEqual

public boolean isLessThanOrEqual(long value)

Check if this is less than or equal to 'value'.

Parameters:

value - Value to compare.

Returns:

True if this is less than or equal.

isZero

public boolean isZero()

Checks if this is zero or not.

Returns:

True if zero.

isDebit

public boolean isDebit()

Checks if this is a debit amount or not.

Returns:

True if negative.

isNegative

public boolean isNegative()

isCredit

public boolean isCredit()

Checks if this is a credit amount or not. Same as isPositive().

Returns:

True if positive.

isPositive

public boolean isPositive()

Checks if this is a positive amount or not.

Returns:

True if positive.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Create the formatted representation of the amount value with appropriate decimals places.

Overrides:

toString in class Object

Returns:

The formatted string representation of the amount.

toString

public String toString(SystemUser forUser)

Create the formatted representation of the amount value with appropriate decimals places.

Returns:

The formatted string representation of the amount.

toString

public String toString(boolean showSymbol)

Create the formatted representation of the amount value with appropriate decimals places.

Parameters:

showSymbol - Determines whether currency symbol should be included or not.

Returns:

The formatted string representation of the amount.

toString

public String toString(boolean showSymbol,
 SystemUser forUser)

Create the formatted representation of the amount value with appropriate decimals places.

Parameters:

showSymbol - Determines whether currency symbol should be included or not.

Returns:

The formatted string representation of the amount.

toString

public String toString(boolean showSymbol,
 boolean tagDebit)

Create the formatted representation of the amount value with appropriate decimals places.

Parameters:

showSymbol - Determines whether currency symbol should be included or not.

tagDebit - Add the "DB" tag for negative (debit) amount or not.

Returns:

The formatted string representation of the amount.

toString

public String toString(boolean showSymbol,
 boolean tagDebit,
 SystemUser forUser)

Create the formatted representation of the amount value with appropriate decimals places.

Parameters:

showSymbol - Determines whether currency symbol should be included or not.

tagDebit - Add the "DB" tag for negative (debit) amount or not.

forUser - For the user (if non-null, the user's locale country will be used for formatting).

Returns:

The formatted string representation of the amount.

getSymbol

public static String getSymbol(Currency currency)

Get the symbol for the given currency. (For example, the symbol for USD is $ and CAD is C$).

Parameters:

currency - Currency.

Returns:

Currency symbol if a standard symbol exists, otherwise 3-character currency code.

getStorableValue

public String getStorableValue()

Description copied from interface: Storable

Get the storable value. By default, Object.toString() is returned.

Specified by:

getStorableValue in interface Storable

Returns:

Storable value as a string.

compareTo

public int compareTo(Money money)

Specified by:

compareTo in interface Comparable<Money>

words

public String words()

Get the currency amount in words.

Returns:

Currency amount in words.

words

public String words(boolean camelCase)

Get the currency amount in words.

Parameters:

camelCase - Whether to show on a camel-case or not.

Returns:

Currency amount in words.

words

public String words(SystemUser forUser)

Get the currency amount in words.

Parameters:

forUser - For the user (if non-null, the user's locale country will be used for formatting).

Returns:

Currency amount in words.

words

public String words(SystemUser forUser,
 boolean camelCase)

Get the currency amount in words.

Parameters:

forUser - For the user (if non-null, the user's locale country will be used for formatting).

camelCase - Whether to show on a camel-case or not.

Returns:

Currency amount in words.

wasRounded

public boolean wasRounded()

Whether a rounding took place when this was created or not.

Returns:

True/false.

currencies

public static List<Currency> currencies()

currencies

public static List<Currency> currencies(boolean includeMetals)

isMetal

public static boolean isMetal(Currency currency)

getFractionDigits

public int getFractionDigits()

getFractionDigits

public static int getFractionDigits(Currency currency)