hera.api.model

Class Aer

java.lang.Object

hera.api.model.Aer

All Implemented Interfaces:

java.lang.Comparable<Aer>

@ApiAudience.Public
 @ApiStability.Unstable
public class Aer
extends java.lang.Object
implements java.lang.Comparable<Aer>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Aer.Unit An unit to represent aergo.

Field Summary

Fields

Modifier and Type	Field and Description
static Aer	AERGO_ONE
static Aer	EMPTY
static java.lang.String	EMPTY_STRING
static Aer	GIGA_ONE
static Aer	ONE
protected java.math.BigInteger	value
static Aer	ZERO

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Aer()
	Aer(java.math.BigInteger amount) Aer constructor.
	Aer(java.lang.String amount) Create Aer instance.
	Aer(java.lang.String amount, Aer.Unit unit) Create Aer instance.

Method Summary

Modifier and Type	Method and Description
Aer	add(Aer other) Returns a Aer whose value is (this.value + other.value).
int	compareTo(Aer other) .
static Aer	of(java.math.BigInteger amount) Create an Aer instance.
static Aer	of(java.lang.String amount) Create Aer instance.
static Aer	of(java.lang.String amount, Aer.Unit unit) Create Aer instance.
protected java.math.BigInteger	parse(java.lang.String value, Aer.Unit unit)
Aer	subtract(Aer other) Returns a Aer whose value is (this.value - other.value).
java.lang.String	toString()
java.lang.String	toString(Aer.Unit unit) Convert aer with unit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_STRING

public static final java.lang.String EMPTY_STRING

See Also:

Constant Field Values

EMPTY

public static final Aer EMPTY

ZERO

public static final Aer ZERO

ONE

public static final Aer ONE

GIGA_ONE

public static final Aer GIGA_ONE

AERGO_ONE

public static final Aer AERGO_ONE

value

protected final java.math.BigInteger value

Constructor Detail

Aer

protected Aer()

Aer

@ApiAudience.Public
public Aer(java.lang.String amount)

Create Aer instance.

Parameters:

amount - an amount in string which is considered as Aer.Unit.AER

Aer

@ApiAudience.Public
public Aer(java.lang.String amount,
                               Aer.Unit unit)

Create Aer instance.

Parameters:

amount - an amount in string

unit - an unit Aer.Unit

Aer

@ApiAudience.Public
public Aer(java.math.BigInteger amount)

Aer constructor.

Parameters:

amount - an amount in Aer.Unit.AER

Method Detail

of

@ApiAudience.Public
public static Aer of(java.lang.String amount)

Create Aer instance.

Parameters:

amount - an amount in string which is considered as Aer.Unit.AER

Returns:

an aergo instance

of

@ApiAudience.Public
public static Aer of(java.lang.String amount,
                                         Aer.Unit unit)

Create Aer instance.

Parameters:

amount - an amount in string

unit - an unit Aer.Unit

Returns:

an aergo instance

of

@ApiAudience.Public
public static Aer of(java.math.BigInteger amount)

Create an Aer instance.

Parameters:

amount - an amount in Aer.Unit.AER

Returns:

an aergo instance

parse

protected java.math.BigInteger parse(java.lang.String value,
                                     Aer.Unit unit)

add

public Aer add(Aer other)

Returns a Aer whose value is (this.value + other.value).

Parameters:

other - value to be added to this aer.

Returns:

this.value + other.value

subtract

public Aer subtract(Aer other)

Returns a Aer whose value is (this.value - other.value). If a subtracted value is less than 0, return 0 Aer.Unit.AER.

Parameters:

other - value to be added to this aer.

Returns:

this.value - other.value

compareTo

public int compareTo(Aer other)

.

Specified by:

compareTo in interface java.lang.Comparable<Aer>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toString

public java.lang.String toString(Aer.Unit unit)

Convert aer with unit.

Parameters:

unit - an aergo unit

Returns:

an aer in unit