Package org.xrpl.xrpl4j.model.client.common

Class LedgerIndex

java.lang.Object

org.xrpl.xrpl4j.model.client.common.LedgerIndex

public class LedgerIndex
extends Object

Represents a ledger index, which can either be an integer or a shortcut String.

See Also:

• "https://xrpl.org/basic-data-types.html#specifying-ledgers"

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()
LedgerIndex	minus(com.google.common.primitives.UnsignedInteger value)	Subtract an UnsignedInteger from this LedgerIndex.
LedgerIndex	minus(LedgerIndex other)	Subtract a LedgerIndex from this LedgerIndex.
static LedgerIndex	of(com.google.common.primitives.UnsignedInteger value)	Construct a LedgerIndex from an UnsignedInteger.
LedgerIndex	plus(com.google.common.primitives.UnsignedInteger other)	Add an UnsignedInteger to this LedgerIndex.
LedgerIndex	plus(LedgerIndex other)	Add another LedgerIndex to this LedgerIndex.
String	toString()
com.google.common.primitives.UnsignedInteger	unsignedIntegerValue()	Accessor for an unsigned integer value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

of

public static LedgerIndex of(com.google.common.primitives.UnsignedInteger value)

Construct a LedgerIndex from an UnsignedInteger.

Parameters:

value - An UnsignedInteger specifying a ledger index.

Returns:

A LedgerIndex with the given value.

Throws:

NullPointerException - if value is null

unsignedIntegerValue

public com.google.common.primitives.UnsignedInteger unsignedIntegerValue()

Accessor for an unsigned integer value.

Returns:

A UnsignedInteger.

plus

public LedgerIndex plus(com.google.common.primitives.UnsignedInteger other)

Add an UnsignedInteger to this LedgerIndex.

Parameters:

other - The UnsignedInteger to add to this LedgerIndex.

Returns:

The sum of the UnsignedInteger and this LedgerIndex's UnsignedInteger value.

plus

public LedgerIndex plus(LedgerIndex other)

Add another LedgerIndex to this LedgerIndex.

Parameters:

other - The LedgerIndex to add to this LedgerIndex.

Returns:

The sum of the LedgerIndex' and this LedgerIndex's UnsignedLong value.

minus

public LedgerIndex minus(LedgerIndex other)

Subtract a LedgerIndex from this LedgerIndex.

Parameters:

other - Another LedgerIndex to subtract.

Returns:

A LedgerIndex wrapping the difference of the two wrapped UnsignedLong values of this LedgerIndex and other.

minus

public LedgerIndex minus(com.google.common.primitives.UnsignedInteger value)

Subtract an UnsignedInteger from this LedgerIndex.

Parameters:

value - An UnsignedInteger to subtract.

Returns:

A LedgerIndex wrapping the difference of this LedgerIndex's value and value.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object