Percentage (Cyclos 4.14.14 Scripting API Documentation)

java.lang.Object
- org.cyclos.utils.Percentage

All Implemented Interfaces:

Serializable, Comparable<Percentage>, HasAmount
```
public class Percentage
extends Object
implements Serializable, HasAmount, Comparable<Percentage>
```
A comparable containing a value but formatted as a percentage.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

Percentage(BigDecimal amount)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(Percentage p)`
`BigDecimal`	`getAmount()`
`BigDecimal`	`getPercentageValue()`
`void`	`setAmount(BigDecimal amount)`
`String`	`toString()`

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

- Constructor Detail
  - Percentage
```
public Percentage(BigDecimal amount)
```
- Method Detail
  - compareTo
```
public int compareTo(Percentage p)
```
    Specified by:
    
    compareTo in interface Comparable<Percentage>
  - getAmount
```
public BigDecimal getAmount()
```
    Specified by:
    
    getAmount in interface HasAmount
  - getPercentageValue
```
public BigDecimal getPercentageValue()
```
    Returns:
    
    the value as a percentage
  - setAmount
```
public void setAmount(BigDecimal amount)
```
    Specified by:
    
    setAmount in interface HasAmount
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object