Package org.xrpl.xrpl4j.model.client.transactions

Interface TransactionResult<TxnType extends Transaction>

Type Parameters:

TxnType - The type of Transaction that was requested.

All Superinterfaces:

XrplResult

All Known Implementing Classes:

ImmutableTransactionResult

@Immutable
public interface TransactionResult<TxnType extends Transaction>
extends XrplResult

The result of a tx rippled API method call.

Field Summary

Fields

Modifier and Type	Field	Description
static long	RIPPLE_EPOCH	XRP Ledger represents dates using a custom epoch called Ripple Epoch.

Method Summary

Modifier and Type	Method	Description
static <T extends Transaction> ImmutableTransactionResult.Builder<T>	builder()	Construct a builder for this class.
Optional<com.google.common.primitives.UnsignedLong>	closeDate()	The approximate close time (using Ripple Epoch) of the ledger containing this transaction.
default Optional<ZonedDateTime>	closeDateHuman()	The approximate close time in UTC offset.
Hash256	hash()	The identifying hash of the Transaction.
Optional<LedgerIndex>	ledgerIndex()	The ledger index of the ledger that includes this Transaction.
default LedgerIndex	ledgerIndexSafe()	Get ledgerIndex(), or throw an IllegalStateException if ledgerIndex() is empty.
Optional<TransactionMetadata>	metadata()	Metadata about the transaction if this data is from a validated ledger version.
TxnType	transaction()	The Transaction that was returned as a result of the "tx" call.
default boolean	validated()	true if this data is from a validated ledger version; If false, this data is not final.

Methods inherited from interface org.xrpl.xrpl4j.model.client.XrplResult

status

Field Detail

RIPPLE_EPOCH

static final long RIPPLE_EPOCH

XRP Ledger represents dates using a custom epoch called Ripple Epoch. This is a constant for the start of that epoch.

See Also:

Constant Field Values

Method Detail

builder

static <T extends Transaction> ImmutableTransactionResult.Builder<T> builder()

Construct a builder for this class.

Type Parameters:

T - The actual type of Transaction.

Returns:

An ImmutableTransactionResult.Builder

transaction

TxnType transaction()

The Transaction that was returned as a result of the "tx" call.

Returns:

A Transaction of type TransactionResult.

ledgerIndex

Optional<LedgerIndex> ledgerIndex()

The ledger index of the ledger that includes this Transaction.

Returns:

An optionally-present LedgerIndex.

ledgerIndexSafe

@Auxiliary
default LedgerIndex ledgerIndexSafe()

Get ledgerIndex(), or throw an IllegalStateException if ledgerIndex() is empty.

Returns:

The value of ledgerIndex().

Throws:

IllegalStateException - If ledgerIndex() is empty.

hash

Hash256 hash()

The identifying hash of the Transaction.

Returns:

The Hash256 of transaction().

validated

@Default
default boolean validated()

true if this data is from a validated ledger version; If false, this data is not final.

Returns:

true if this data is from a validated ledger version; If false, this data is not final.

metadata

Optional<TransactionMetadata> metadata()

Metadata about the transaction if this data is from a validated ledger version.

Returns:

metadata or empty for non-validated transactions.

closeDate

Optional<com.google.common.primitives.UnsignedLong> closeDate()

The approximate close time (using Ripple Epoch) of the ledger containing this transaction. This is an undocumented field.

Returns:

An optionally-present UnsignedLong.

closeDateHuman

@Auxiliary
default Optional<ZonedDateTime> closeDateHuman()

The approximate close time in UTC offset. This is derived from undocumented field.

Returns:

An optionally-present ZonedDateTime.