Money (Aerodrome 1.0-SNAPSHOT API)

java.lang.Object
- com.buffalokiwi.utils.Money

All Implemented Interfaces:

Comparable<Money>
```
public class Money
extends Object
implements Comparable<Money>
```
This makes money work properly. As a bonus, I'm fairly certain this is thread safe.

Author:

John Quinn

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_COUNTRY` Default country code for locale
`static String`	`DEFAULT_LANGUAGE` Default Language used for locale
`static RoundingMode`	`DEFAULT_ROUNDING` Default rounding mode is HALF_UP

Constructor Summary

Constructors
Constructor and Description
`Money()` Create a new default money instance with a zero value using default rounding
`Money(BigDecimal aAmount)` Create a new money instance with an amount using default currency and rounding mode
`Money(BigDecimal aAmount, Currency aCurrency)` Create a new money instance with custom currencies and rounding mode
`Money(BigDecimal aAmount, Locale locale, Currency aCurrency, RoundingMode aMode)` Create a new money instance with custom currencies and rounding mode
`Money(double aAmount)` Create a new money instance
`Money(int aAmount)` Create a new money instance
`Money(Money m)` Create a copy of some other money instance
`Money(String aAmount)` Create a new money instance

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Money`	`abs()`
`BigDecimal`	`asBigDecimal()`
`int`	`asDBInteger()` Multiply the current amount by 100 and return the integer value
`int`	`compareTo(Money aThat)`
`static Money`	`createFromStringOrZero(String money)` Create a new Money instance, and if something goes wrong return a money instance with a zero amount.
`boolean`	`currencyMatch(Money aThat)` Check to see if currencies match
`Money`	`div(double divisor)`
`Money`	`div(int divisor)`
`Money`	`div(Money divisor)`
`boolean`	`equals(Money aThat)` Equals (insensitive to scale).
`boolean`	`equals(Object aThat)`
`float`	`floatValue()`
`static Money`	`fromDBInt(int val)`
`Currency`	`getCurrency()`
`Locale`	`getLocale()`
`RoundingMode`	`getRoundingMode()`
`Locale[]`	`getValidLocales()` Return a list of valid locales
`String[]`	`getValidLocaleStrings()` Return a list of valid locales by string representation
`boolean`	`greaterThan(Money aThat)` Greater than.
`boolean`	`greaterThanEqualToZero()`
`boolean`	`greaterThanOrEqualTo(Money aThat)` Greater than or equal to.
`boolean`	`greaterThanZero()`
`int`	`hashCode()`
`int`	`intVal()` Retrieve the exact value as an integer.
`boolean`	`isEmpty()` Check to see of money is zero
`boolean`	`isNegative()` Check to see if money is negative
`boolean`	`isPositive()` Check to see if money is positive
`boolean`	`lessThan(Money aThat)` Less than.
`boolean`	`lessThanEqualToZero()`
`boolean`	`lessThanOrEqualTo(Money aThat)` Less than or equal to.
`boolean`	`lessThanZero()`
`Money`	`minus(Money m)` Subtract money from money
`int`	`mod(int divisor)`
`Money`	`negate()`
`Money`	`plus(Money m)` Add 2 monies together
`Money`	`sum(Collection<Money> cm)` Add a collection of moneys together
`Money`	`times(double factor)`
`Money`	`times(int factor)`
`Money`	`times(Money factor)`
`String`	`toCurrencyString()`
`String`	`toPercentString()`
`String`	`toString()`

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

- Field Detail
  - DEFAULT_ROUNDING
```
public static final RoundingMode DEFAULT_ROUNDING
```
    Default rounding mode is HALF_UP
  - DEFAULT_LANGUAGE
```
public static final String DEFAULT_LANGUAGE
```
    Default Language used for locale
    
    See Also:
    
    Constant Field Values
  - DEFAULT_COUNTRY
```
public static final String DEFAULT_COUNTRY
```
    Default country code for locale
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Money
```
public Money()
```
    Create a new default money instance with a zero value using default rounding
  - Money
```
public Money(Money m)
```
    Create a copy of some other money instance
    
    Parameters:
    
    m -
  - Money
```
public Money(BigDecimal aAmount,
             Locale locale,
             Currency aCurrency,
             RoundingMode aMode)
```
    Create a new money instance with custom currencies and rounding mode
    
    Parameters:
    
    aAmount - Amount
    
    locale - The locale
    
    aCurrency - Currency
    
    aMode - Rounding Mode
  - Money
```
public Money(BigDecimal aAmount,
             Currency aCurrency)
```
    Create a new money instance with custom currencies and rounding mode
    
    Parameters:
    
    aAmount - Amount
    
    aCurrency - Currency
  - Money
```
public Money(BigDecimal aAmount)
```
    Create a new money instance with an amount using default currency and rounding mode
    
    Parameters:
    
    aAmount - Amount
  - Money
```
public Money(int aAmount)
```
    Create a new money instance
    
    Parameters:
    
    aAmount - Amount
  - Money
```
public Money(String aAmount)
      throws ParseException
```
    Create a new money instance
    
    Parameters:
    
    aAmount - Amount
    
    Throws:
    
    ParseException
  - Money
```
public Money(double aAmount)
```
    Create a new money instance
    
    Parameters:
    
    aAmount - Amount
- Method Detail
  - createFromStringOrZero
```
public static Money createFromStringOrZero(String money)
```
    Create a new Money instance, and if something goes wrong return a money instance with a zero amount.
    
    Parameters:
    
    money -
    
    Returns:
  - fromDBInt
```
public static Money fromDBInt(int val)
```
  - currencyMatch
```
public boolean currencyMatch(Money aThat)
```
    Check to see if currencies match
    
    Parameters:
    
    aThat - Money to check
    
    Returns:
    
    if currencies match
  - isPositive
```
public boolean isPositive()
```
    Check to see if money is positive
    
    Returns:
    
    is positive
  - isNegative
```
public boolean isNegative()
```
    Check to see if money is negative
    
    Returns:
    
    is negative
  - isEmpty
```
public boolean isEmpty()
```
    Check to see of money is zero
    
    Returns:
    
    is zero
  - plus
```
public Money plus(Money m)
           throws CurrencyMismatchException
```
    Add 2 monies together
    
    Parameters:
    
    m - Money
    
    Returns:
    
    Money + money
    
    Throws:
    
    CurrencyMismatchException - if currencies don't match
  - sum
```
public Money sum(Collection<Money> cm)
          throws CurrencyMismatchException
```
    Add a collection of moneys together
    
    Parameters:
    
    cm - Money collection
    
    Returns:
    
    Sum of money in collection
    
    Throws:
    
    CurrencyMismatchException - if currencies don't match
  - minus
```
public Money minus(Money m)
            throws CurrencyMismatchException
```
    Subtract money from money
    
    Parameters:
    
    m - Amount to subtract
    
    Returns:
    
    new amount
    
    Throws:
    
    CurrencyMismatchException
  - times
```
public Money times(double factor)
```
  - times
```
public Money times(int factor)
```
  - times
```
public Money times(Money factor)
            throws CurrencyMismatchException
```
    Throws:
    
    CurrencyMismatchException
  - div
```
public Money div(int divisor)
```
  - div
```
public Money div(double divisor)
```
  - div
```
public Money div(Money divisor)
```
  - mod
```
public int mod(int divisor)
```
  - abs
```
public Money abs()
```
  - negate
```
public Money negate()
```
  - getCurrency
```
public Currency getCurrency()
```
  - getLocale
```
public Locale getLocale()
```
  - getRoundingMode
```
public RoundingMode getRoundingMode()
```
  - asBigDecimal
```
public BigDecimal asBigDecimal()
```
  - floatValue
```
public float floatValue()
```
  - toCurrencyString
```
public String toCurrencyString()
```
  - toPercentString
```
public String toPercentString()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValidLocales
```
public Locale[] getValidLocales()
```
    Return a list of valid locales
    
    Returns:
    
    Valid locale list
  - getValidLocaleStrings
```
public String[] getValidLocaleStrings()
```
    Return a list of valid locales by string representation
    
    Returns:
    
    Locale string list
  - equals
```
public boolean equals(Money aThat)
```
    Equals (insensitive to scale).
    Return true only if the amounts are equal. Currencies must match. This method is not synonymous with the equals method.
  - greaterThan
```
public boolean greaterThan(Money aThat)
```
    Greater than.
    Return true only if 'this' amount is greater than 'that' amount. Currencies must match.
  - greaterThanZero
```
public boolean greaterThanZero()
```
  - greaterThanEqualToZero
```
public boolean greaterThanEqualToZero()
```
  - lessThanZero
```
public boolean lessThanZero()
```
  - lessThanEqualToZero
```
public boolean lessThanEqualToZero()
```
  - greaterThanOrEqualTo
```
public boolean greaterThanOrEqualTo(Money aThat)
```
    Greater than or equal to.
    Return true only if 'this' amount is greater than or equal to 'that' amount. Currencies must match.
  - lessThan
```
public boolean lessThan(Money aThat)
```
    Less than.
    Return true only if 'this' amount is less than 'that' amount. Currencies must match.
  - lessThanOrEqualTo
```
public boolean lessThanOrEqualTo(Money aThat)
```
    Less than or equal to.
    Return true only if 'this' amount is less than or equal to 'that' amount. Currencies must match.
  - intVal
```
public int intVal()
```
    Retrieve the exact value as an integer. This is good for when the money is represented by an int.
    
    Returns:
    
    int val
  - asDBInteger
```
public int asDBInteger()
```
    Multiply the current amount by 100 and return the integer value
    
    Returns:
    
    amount * 100
  - equals
```
public boolean equals(Object aThat)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(Money aThat)
```
    Specified by:
    
    compareTo in interface Comparable<Money>

Class Money

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ROUNDING

DEFAULT_LANGUAGE

DEFAULT_COUNTRY

Constructor Detail

Money

Money

Money

Money

Money

Money

Money

Money

Method Detail

createFromStringOrZero

fromDBInt

currencyMatch

isPositive

isNegative

isEmpty

plus

sum

minus

times

times

times

div

div

div

mod

abs

negate

getCurrency

getLocale

getRoundingMode

asBigDecimal

floatValue

toCurrencyString

toPercentString

toString

getValidLocales

getValidLocaleStrings

equals

greaterThan

greaterThanZero

greaterThanEqualToZero

lessThanZero

lessThanEqualToZero

greaterThanOrEqualTo

lessThan

lessThanOrEqualTo

intVal

asDBInteger

equals

hashCode

compareTo