CurrencyAmount (Cyclos 4.16.19 Scripting API Documentation)

java.lang.Object
- org.cyclos.entities.utils.CurrencyAmount

All Implemented Interfaces:

Comparable<CurrencyAmount>, HasCurrency, HasCurrencyAmount, ProcessableForProxying, ICurrencyAmount, HasAmount

Direct Known Subclasses:

RatedCurrencyAmount
```
@Embeddable
public class CurrencyAmount
extends Object
implements ICurrencyAmount, HasCurrencyAmount, ProcessableForProxying, Comparable<CurrencyAmount>
```
Contains both an amount and a currency

Field Summary

Fields
Modifier and Type Field Description

static Comparator<CurrencyAmount> COMPARATOR

Constructor Summary

Constructors
Constructor Description

CurrencyAmount()

CurrencyAmount(Currency currency, BigDecimal amount)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`CurrencyAmount`	`abs()`
`int`	`compareTo(CurrencyAmount o)`
`boolean`	`equals(Object obj)`
`BigDecimal`	`getAmount()`
`Currency`	`getCurrency()`
`CurrencyAmount`	`getCurrencyAmount()`
`int`	`hashCode()`
`static CurrencyAmount`	`of(Currency currency, BigDecimal amount)`	Creates a new instance.
`void`	`setAmount(BigDecimal amount)`
`void`	`setCurrency(Currency currency)`

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

Methods inherited from interface org.cyclos.entities.banking.HasCurrency
round, withCurrency

Methods inherited from interface org.cyclos.entities.ProcessableForProxying
getProxyClass

Field Detail

COMPARATOR

public static final Comparator<CurrencyAmount> COMPARATOR

Constructor Detail

CurrencyAmount
```
public CurrencyAmount()
```

CurrencyAmount

public CurrencyAmount(Currency currency,
                      BigDecimal amount)

Method Detail
- of
```
public static CurrencyAmount of(Currency currency,
                                BigDecimal amount)
```
  Creates a new instance. When either currency or amount are null, returns null.
- abs
```
public CurrencyAmount abs()
```
- compareTo
```
public int compareTo(CurrencyAmount o)
```
  Specified by:
  
  compareTo in interface Comparable<CurrencyAmount>
- equals
```
public boolean equals(Object obj)
```
  Overrides:
  
  equals in class Object
- getAmount
```
public BigDecimal getAmount()
```
  Specified by:
  
  getAmount in interface HasAmount
- getCurrency
```
public Currency getCurrency()
```
  Specified by:
  
  getCurrency in interface HasCurrency
  
  Specified by:
  
  getCurrency in interface ICurrencyAmount
- getCurrencyAmount
```
public CurrencyAmount getCurrencyAmount()
```
  Specified by:
  
  getCurrencyAmount in interface HasCurrencyAmount
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class Object
- setAmount
```
public void setAmount(BigDecimal amount)
```
  Specified by:
  
  setAmount in interface HasAmount
- setCurrency
```
public void setCurrency(Currency currency)
```