com.knowgate.currency

Class Money

java.lang.Object

java.lang.Number

java.math.BigDecimal

com.knowgate.currency.Money

All Implemented Interfaces:

Serializable, Comparable<BigDecimal>

public class Money
extends BigDecimal

Combination of BigDecimal with Currency Sign

This class handles money amounts that include a currency sign

Version:

1.0

Author:

Sergio Montoro Ten

See Also:

Serialized Form

Field Summary

Fields inherited from class java.math.BigDecimal

ONE, ROUND_CEILING, ROUND_DOWN, ROUND_FLOOR, ROUND_HALF_DOWN, ROUND_HALF_EVEN, ROUND_HALF_UP, ROUND_UNNECESSARY, ROUND_UP, TEN, ZERO

Constructor Summary

Constructors

Constructor and Description
Money(BigDecimal oVal, CurrencyCode oCur) Constructor
Money(BigDecimal oVal, String sCur) Constructor
Money(BigInteger oVal, CurrencyCode oCur) Constructor
Money(BigInteger oVal, String sCur) Constructor
Money(double dVal, CurrencyCode oCur) Constructor
Money(double dVal, String sCur) Constructor
Money(Money oVal) Constructor that makes a copy from another Money value
Money(String sVal, CurrencyCode oCur) Constructor
Money(String sVal, String sCur) Constructor

Method Summary

Modifier and Type	Method and Description
Money	add(Money oMny) Add two money amounts
int	compareTo(Money oMny) Compare to money amounts with the same currency
Money	convertTo(CurrencyCode oTarget, BigDecimal oRatio) Convert this money to another currency
Money	convertTo(String sTarget, BigDecimal oRatio) Convert this money to another currency
CurrencyCode	currencyCode()
String	format(String sLanguage, String sCountry) Format a BigDecimal as a String following the rules for an specific language and country
static boolean	isMoney(String sVal) Checks whether the given string can be parsed as a valid Money value
Money	max(Money oMny) Maximum of this Money instance and given Money instance
Money	min(Money oMny) Minimum of this Money instance and given Money instance
static Money	parse(String sVal) Create a Money instance from a figure and currency
Money	round2() Rounds a BigDecimal value to two decimals
Money	subtract(Money oMny) Subtract two money amounts
String	toLocaleString()

Methods inherited from class java.math.BigDecimal

abs, abs, add, add, byteValueExact, compareTo, divide, divide, divide, divide, divide, divide, divideAndRemainder, divideAndRemainder, divideToIntegralValue, divideToIntegralValue, doubleValue, equals, floatValue, hashCode, intValue, intValueExact, longValue, longValueExact, max, min, movePointLeft, movePointRight, multiply, multiply, negate, negate, plus, plus, pow, pow, precision, remainder, remainder, round, scale, scaleByPowerOfTen, setScale, setScale, setScale, shortValueExact, signum, stripTrailingZeros, subtract, subtract, toBigInteger, toBigIntegerExact, toEngineeringString, toPlainString, toString, ulp, unscaledValue, valueOf, valueOf, valueOf

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Constructor Detail

Money

public Money(Money oVal)

Constructor that makes a copy from another Money value

Parameters:

oVal - Money

Money

public Money(String sVal,
             CurrencyCode oCur)
      throws NumberFormatException

Constructor

Parameters:

sVal - String Numeric value in US decimal format (using dot as decimal delimiter)

oCur - CurrencyCode

Throws:

NumberFormatException

Money

public Money(String sVal,
             String sCur)
      throws NumberFormatException,
             IllegalArgumentException

Constructor

Parameters:

sVal - String Numeric value in US decimal format (using dot as decimal delimiter)

sCur - String Currency alphanumeric code {"USD", "EUR", etc.}

Throws:

NumberFormatException

IllegalArgumentException

Money

public Money(double dVal,
             CurrencyCode oCur)

Constructor

Parameters:

dVal - double

oCur - CurrencyCode

Money

public Money(double dVal,
             String sCur)
      throws IllegalArgumentException

Constructor

Parameters:

dVal - double

sCur - String Currency alphanumeric code {"USD", "EUR", etc.}

Throws:

IllegalArgumentException - if currency code is not recognized

Money

public Money(BigDecimal oVal,
             String sCur)

Constructor

Parameters:

oVal - BigDecimal

sCur - String Currency alphanumeric code {"USD", "EUR", etc.}

Throws:

IllegalArgumentException - if currency code is not recognized

Money

public Money(BigDecimal oVal,
             CurrencyCode oCur)

Constructor

Parameters:

oVal - BigDecimal

oCur - CurrencyCode

Money

public Money(BigInteger oVal,
             CurrencyCode oCur)

Constructor

Parameters:

oVal - BigInteger

oCur - CurrencyCode

Money

public Money(BigInteger oVal,
             String sCur)

Constructor

Parameters:

oVal - BigInteger

sCur - String Currency alphanumeric code {"USD", "EUR", etc.}

Throws:

IllegalArgumentException - if currency code is not recognized

Method Detail

currencyCode

public CurrencyCode currencyCode()

compareTo

public int compareTo(Money oMny)
              throws IllegalArgumentException

Compare to money amounts with the same currency

Parameters:

oMny - Money

Returns:

int Zero if this amount is equal to given amount. Less than zero if if this amount is less than given amount. More than zero if if this amount is greater than given amount.

Throws:

IllegalArgumentException - If currency codes are not the same

max

public Money max(Money oMny)

Maximum of this Money instance and given Money instance

Parameters:

oMny - Money

Returns:

Money

min

public Money min(Money oMny)

Minimum of this Money instance and given Money instance

Parameters:

oMny - Money

Returns:

Money

add

public Money add(Money oMny)
          throws NullPointerException,
                 IllegalArgumentException

Add two money amounts

The return value is in the currency of this object. If the added amount does not have the same currency then it is converted by calling a web service before performing addition. The scale of the returned value is max(this.scale(), oMny.scale()).

Returns:

this.value + (to this currency) oMny.value

Throws:

NullPointerException - If oMny is null

IllegalArgumentException - If currency codes are not the same

subtract

public Money subtract(Money oMny)
               throws NullPointerException

Subtract two money amounts

The return value is in the currency of this object. If the added amount does not have the same currency then it is converted by calling a web service before performing addition. The scale of the returned value is max(this.scale(), oMny.scale()).

Returns:

this.value - (to this currency) oMny.value

Throws:

NullPointerException - If oMny is null

IllegalArgumentException - If currency codes are not the same

isMoney

public static boolean isMoney(String sVal)

Checks whether the given string can be parsed as a valid Money value

Both comma and dot are allowed as either thousands or decimal delimiters. If there is only a comma or a dot then it is assumed to be de decimal delimiter. If both comma and dot are present, then the leftmost of them is assumed to be the thousands delimiter and the rightmost is the decimal delimiter. Any letters and currency symbols {€$£¤¢¥#ƒ&} are ignored

Parameters:

sVal - String

Returns:

boolean

parse

public static Money parse(String sVal)
                   throws NullPointerException,
                          IllegalArgumentException,
                          NumberFormatException

Create a Money instance from a figure and currency

Parameters:

sVal - String Must be of the form Currency Code + Figure or Figure + Currency Code. For example "23,5 EUR" or "GBP 12.8" The figure may contain dot or comma as a decimal delimiter. € $ £ and ¥ are also recognized as currency codes

Returns:

Money

Throws:

NullPointerException - If String parameter is null

IllegalArgumentException - If String parameter is an empty String

NumberFormatException

round2

public Money round2()

Rounds a BigDecimal value to two decimals

Returns:

BigDecimal

convertTo

public Money convertTo(CurrencyCode oTarget,
                       BigDecimal oRatio)
                throws NullPointerException

Convert this money to another currency

Parameters:

oTarget - Target CurrencyCode

oRatio - BigDecimal Conversion ratio

Returns:

Money if this CurrencyCode is the same as oTarget then this is returned without any modification, if if this CurrencyCode is different from oTarget then the returned value is this multiplied by oRatio.

Throws:

NullPointerException - if oTarget is null

convertTo

public Money convertTo(String sTarget,
                       BigDecimal oRatio)
                throws NullPointerException,
                       IllegalArgumentException

Convert this money to another currency

Parameters:

sTarget - Target CurrencyCode

oRatio - BigDecimal Conversion ratio

Returns:

Money if this CurrencyCode is the same as oTarget then this is returned without any modification, if if this CurrencyCode is different from oTarget then the returned value is this multiplied by oRatio.

Throws:

NullPointerException - if oTarget is null

IllegalArgumentException

format

public String format(String sLanguage,
                     String sCountry)

Format a BigDecimal as a String following the rules for an specific language and country

Parameters:

sLanguage - String ISO-639 two letter language code

sCountry - String ISO-3166 two leter country code

Returns:

String

toLocaleString

public String toLocaleString()

Returns:

String BigDecimal.toString() followed by a single space and currencyCode().alphacode()