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

Interface LedgerSpecifier

All Known Implementing Classes:

ImmutableLedgerSpecifier

@Immutable
public interface LedgerSpecifier

Represents one of the three ways of specifying a ledger in a rippled API request.

See Also:

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

Field Summary

Fields

Modifier and Type	Field	Description
static LedgerSpecifier	CLOSED	Request information about the most recent ledger that has been closed for modifications and proposed for validation.
static LedgerSpecifier	CURRENT	Request information about for the most recent ledger that has been validated by consensus.
static LedgerSpecifier	VALIDATED	Request information about a rippled server's current working version of the ledger.

Method Summary

Modifier and Type	Method	Description
default void	handle(Consumer<Hash256> ledgerHashHandler, Consumer<LedgerIndex> ledgerIndexHandler, Consumer<LedgerIndexShortcut> ledgerIndexShortcutHandler)	Handle this LedgerSpecifier depending on which specifier is present.
Optional<Hash256>	ledgerHash()	A 20-byte hex string for the ledger version to use.
Optional<LedgerIndex>	ledgerIndex()	The ledger index of the ledger to use.
Optional<LedgerIndexShortcut>	ledgerIndexShortcut()	A shortcut word specifying the ledger to use.
default <R> R	map(Function<Hash256,R> ledgerHashMapper, Function<LedgerIndex,R> ledgerIndexMapper, Function<LedgerIndexShortcut,R> ledgerIndexShortcutMapper)	Map this LedgerSpecifier to an instance of LedgerSpecifier, depending on which specifier is present.
static LedgerSpecifier	of(int ledgerIndex)	Construct a LedgerSpecifier with a numerical ledger index.
static LedgerSpecifier	of(com.google.common.primitives.UnsignedInteger ledgerIndex)	Construct a LedgerSpecifier with a numerical ledger index.
static LedgerSpecifier	of(LedgerIndex ledgerIndex)	Construct a LedgerSpecifier with a numerical ledger index.
static LedgerSpecifier	of(Hash256 ledgerHash)	Construct a LedgerSpecifier with a ledger hash.
default void	validateOnlyOneSpecified()	Validates that only one of the three fields in a LedgerSpecifier is present.

Field Detail

VALIDATED

static final LedgerSpecifier VALIDATED

Request information about a rippled server's current working version of the ledger.

CURRENT

static final LedgerSpecifier CURRENT

Request information about for the most recent ledger that has been validated by consensus.

CLOSED

static final LedgerSpecifier CLOSED

Request information about the most recent ledger that has been closed for modifications and proposed for validation.

Method Detail

of

static LedgerSpecifier of(Hash256 ledgerHash)

Construct a LedgerSpecifier with a ledger hash.

Parameters:

ledgerHash - A Hash256 containing the ledger hash of the desired ledger.

Returns:

A LedgerSpecifier containing ledgerHash.

of

static LedgerSpecifier of(LedgerIndex ledgerIndex)

Construct a LedgerSpecifier with a numerical ledger index.

Parameters:

ledgerIndex - The LedgerIndex of the desired ledger.

Returns:

A LedgerSpecifier containing ledgerIndex.

of

static LedgerSpecifier of(com.google.common.primitives.UnsignedInteger ledgerIndex)

Construct a LedgerSpecifier with a numerical ledger index.

Parameters:

ledgerIndex - The UnsignedInteger of the desired ledger.

Returns:

A LedgerSpecifier containing ledgerIndex.

of

static LedgerSpecifier of(int ledgerIndex)

Construct a LedgerSpecifier with a numerical ledger index.

Parameters:

ledgerIndex - The int of the desired ledger.

Returns:

A LedgerSpecifier containing ledgerIndex.

ledgerHash

Optional<Hash256> ledgerHash()

A 20-byte hex string for the ledger version to use.

Returns:

An optionally-present Hash256.

ledgerIndex

Optional<LedgerIndex> ledgerIndex()

The ledger index of the ledger to use.

Returns:

An optionally-present LedgerIndex.

ledgerIndexShortcut

Optional<LedgerIndexShortcut> ledgerIndexShortcut()

A shortcut word specifying the ledger to use.

Returns:

An optionally-present LedgerIndexShortcut.

handle

@Auxiliary
default void handle(Consumer<Hash256> ledgerHashHandler,
                    Consumer<LedgerIndex> ledgerIndexHandler,
                    Consumer<LedgerIndexShortcut> ledgerIndexShortcutHandler)

Handle this LedgerSpecifier depending on which specifier is present.

Parameters:

ledgerHashHandler - A Consumer that is called if ledgerHash() is present.

ledgerIndexHandler - A Consumer that is called if ledgerIndex() is present.

ledgerIndexShortcutHandler - A Consumer that is called if ledgerIndexShortcut() is present.

map

@Auxiliary
default <R> R map(Function<Hash256,R> ledgerHashMapper,
                  Function<LedgerIndex,R> ledgerIndexMapper,
                  Function<LedgerIndexShortcut,R> ledgerIndexShortcutMapper)

Map this LedgerSpecifier to an instance of LedgerSpecifier, depending on which specifier is present.

Type Parameters:

R - The type of object to return after mapping.

Parameters:

ledgerHashMapper - A Function that is called if ledgerHash() is present.

ledgerIndexMapper - A Function that is called if ledgerIndex() is present.

ledgerIndexShortcutMapper - A Function that is called if ledgerIndexShortcut() is present.

Returns:

A LedgerSpecifier that is constructed by the appropriate mapper function.

validateOnlyOneSpecified

@Check
default void validateOnlyOneSpecified()

Validates that only one of the three fields in a LedgerSpecifier is present.