Cash (ObjectLab Kit 1.4.8 API)

java.lang.Object
- net.objectlab.kit.fxcalc.Cash

All Implemented Interfaces:

CurrencyAmount
```
public class Cash
extends Object
implements CurrencyAmount
```
A simple class to represent an immutable amount of a given currency.

Author:

Benoit Xhenseval

Constructor Summary

Constructors
Constructor and Description

Cash(String currency, BigDecimal amount)

Constructors
Constructor and Description
`Cash(String currency, BigDecimal amount)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CurrencyAmount`	`add(CurrencyAmount money)` Add the amount with the existing one and return a new immutable Money.
`boolean`	`equals(Object obj)`
`BigDecimal`	`getAmount()`
`String`	`getCurrency()`
`int`	`hashCode()`
`CurrencyAmount`	`negate()` Swap the sign on the amount and return a new immutable Money.
`static Cash`	`of(String currency, BigDecimal amount)`
`static Cash`	`of(String currency, long amount)`
`static Cash`	`of(String currency, String amount)`
`CurrencyAmount`	`subtract(CurrencyAmount money)` Subtract the amount from the existing one and return a new immutable Money.
`String`	`toString()`

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

- Constructor Detail
  - Cash
```
public Cash(String currency,
            BigDecimal amount)
```
- Method Detail
  - of
```
public static Cash of(String currency,
                      BigDecimal amount)
```
  - of
```
public static Cash of(String currency,
                      String amount)
```
  - of
```
public static Cash of(String currency,
                      long amount)
```
  - getCurrency
```
public String getCurrency()
```
    Specified by:
    
    getCurrency in interface CurrencyAmount
  - getAmount
```
public BigDecimal getAmount()
```
    Specified by:
    
    getAmount in interface CurrencyAmount
  - 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
  - negate
```
public CurrencyAmount negate()
```
    Swap the sign on the amount and return a new immutable Money.
    
    Specified by:
    
    negate in interface CurrencyAmount
  - add
```
public CurrencyAmount add(CurrencyAmount money)
```
    Add the amount with the existing one and return a new immutable Money.
    
    Specified by:
    
    add in interface CurrencyAmount
    
    Throws:
    
    IllegalArgumentException - if the money.currency does not match the current one.
  - subtract
```
public CurrencyAmount subtract(CurrencyAmount money)
```
    Subtract the amount from the existing one and return a new immutable Money.
    
    Specified by:
    
    subtract in interface CurrencyAmount
    
    Throws:
    
    IllegalArgumentException - if the money.currency does not match the current one.

Class Cash

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Cash

Method Detail

of

of

of

getCurrency

getAmount

toString

hashCode

equals

negate

add

subtract