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

Class LedgerIndexBound

java.lang.Object

org.xrpl.xrpl4j.model.immutables.Wrapper<Long>

org.xrpl.xrpl4j.model.client.common.LedgerIndexBound

All Implemented Interfaces:

Serializable, Comparable<Wrapper<Long>>

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class LedgerIndexBound
extends Wrapper<Long>

This class is similar to LedgerIndex in that it represents a numerical ledger version on the XRP Ledger. However, LedgerIndexBound can be used to specify ranges of ledgers in some rippled API request objects, such as AccountTransactionsRequestParams. Unlike LedgerIndex which wraps an unsigned long value, this class supports -1 and does not allow 0.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
void	checkBounds()	Ensures that this LedgerIndexBound is not less than -1 and not equal to 0.
LedgerIndexBound	minus(Integer value)	Subtract an Integer from this LedgerIndexBound.
LedgerIndexBound	minus(Long value)	Subtract a Long from this LedgerIndexBound.
LedgerIndexBound	minus(LedgerIndex ledgerIndex)	Subtract a LedgerIndex from this LedgerIndexBound.
LedgerIndexBound	minus(LedgerIndexBound other)	Subtract a LedgerIndexBound from this LedgerIndexBound.
static LedgerIndexBound	of(int ledgerIndexBound)	Static constructor.
static LedgerIndexBound	of(Long value)	Construct a new immutable LedgerIndexBound instance.
LedgerIndexBound	plus(Integer value)	Add an Integer to this LedgerIndexBound.
LedgerIndexBound	plus(Long value)	Add a Long to this LedgerIndexBound.
LedgerIndexBound	plus(LedgerIndex ledgerIndex)	Add a LedgerIndex to this LedgerIndexBound.
LedgerIndexBound	plus(LedgerIndexBound other)	Add a LedgerIndexBound to this LedgerIndexBound.
String	toString()
static LedgerIndexBound	unbounded()
Long	value()	The wrapped value.

Methods inherited from class org.xrpl.xrpl4j.model.immutables.Wrapper

compareTo, equals, hashCode

Methods inherited from class java.lang.Object

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

Method Details

value

public Long value()

The wrapped value.

Specified by:

value in class Wrapper<Long>

Returns:

The wrapped value.

of

public static LedgerIndexBound of(Long value)

Construct a new immutable LedgerIndexBound instance.

Parameters:

value - The value for the value attribute

Returns:

An immutable LedgerIndexBound instance

of

public static LedgerIndexBound of(int ledgerIndexBound)

Static constructor.

Parameters:

ledgerIndexBound - An integer representing the ledger-index bound.

Returns:

A LedgerIndexBound.

unbounded

public static LedgerIndexBound unbounded()

toString

public String toString()

Overrides:

toString in class Wrapper<Long>

plus

public LedgerIndexBound plus(LedgerIndexBound other)

Add a LedgerIndexBound to this LedgerIndexBound.

Parameters:

other - Another LedgerIndexBound to add.

Returns:

A LedgerIndexBound wrapping the sum of the two wrapped Long values of this LedgerIndexBound and other.

plus

public LedgerIndexBound plus(LedgerIndex ledgerIndex)

Add a LedgerIndex to this LedgerIndexBound.

Parameters:

ledgerIndex - A LedgerIndex to add to this LedgerIndexBound.

Returns:

A LedgerIndexBound wrapping the sum of the two values of this LedgerIndexBound and ledgerIndex.

plus

public LedgerIndexBound plus(Long value)

Add a Long to this LedgerIndexBound.

Parameters:

value - A Long to add.

Returns:

A LedgerIndexBound wrapping the sum of this LedgerIndexBound's value and value.

plus

public LedgerIndexBound plus(Integer value)

Add an Integer to this LedgerIndexBound.

Parameters:

value - An Integer to add.

Returns:

A LedgerIndexBound wrapping the sum of this LedgerIndexBound's value and value.

minus

public LedgerIndexBound minus(LedgerIndexBound other)

Subtract a LedgerIndexBound from this LedgerIndexBound.

Parameters:

other - Another LedgerIndexBound to subtract.

Returns:

A LedgerIndexBound wrapping the difference of the two wrapped Long values of this LedgerIndexBound and other.

minus

public LedgerIndexBound minus(LedgerIndex ledgerIndex)

Subtract a LedgerIndex from this LedgerIndexBound.

Parameters:

ledgerIndex - A LedgerIndex to subtract.

Returns:

A LedgerIndexBound wrapping the difference of the two values of this LedgerIndexBound and ledgerIndex.

minus

public LedgerIndexBound minus(Long value)

Subtract a Long from this LedgerIndexBound.

Parameters:

value - A Long to subtract.

Returns:

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

minus

public LedgerIndexBound minus(Integer value)

Subtract an Integer from this LedgerIndexBound.

Parameters:

value - An Integer to subtract.

Returns:

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

checkBounds

@Check
public void checkBounds()

Ensures that this LedgerIndexBound is not less than -1 and not equal to 0.