Package org.xrpl.xrpl4j.model.client.oracle

Interface GetAggregatePriceResult

All Superinterfaces:

XrplResult

All Known Implementing Classes:

ImmutableGetAggregatePriceResult

@Beta
@Immutable
public interface GetAggregatePriceResult
extends XrplResult

Result object for get_aggregate_price RPC calls.

Method Summary

Modifier and Type	Method	Description
static ImmutableGetAggregatePriceResult.Builder	builder()	Construct a GetAggregatePriceResult builder.
AggregatePriceSet	entireSet()	The statistics from the collected oracle prices.
Optional<LedgerIndex>	ledgerCurrentIndex()	The ledger index of the current open ledger, which was used when retrieving this information.
default LedgerIndex	ledgerCurrentIndexSafe()	Get ledgerCurrentIndex(), or throw an IllegalStateException if ledgerCurrentIndex() is empty.
Optional<Hash256>	ledgerHash()	The identifying Hash of the ledger version used to generate this response.
default Hash256	ledgerHashSafe()	Get ledgerHash(), or throw an IllegalStateException if ledgerHash() is empty.
Optional<LedgerIndex>	ledgerIndex()	The Ledger Index of the ledger version used to generate this response.
default LedgerIndex	ledgerIndexSafe()	Get ledgerIndex(), or throw an IllegalStateException if ledgerIndex() is empty.
default BigDecimal	median()	Get the median price as a BigDecimal.
String	medianString()	The median price, as a String.
com.google.common.primitives.UnsignedInteger	time()	The most recent timestamp out of all LastUpdateTime values.
Optional<AggregatePriceSet>	trimmedSet()	The trimmed statistics from the collected oracle prices.
default boolean	validated()	If true, the information in this response comes from a validated ledger version.

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

status

Method Details

builder

static ImmutableGetAggregatePriceResult.Builder builder()

Construct a GetAggregatePriceResult builder.

Returns:

An ImmutableGetAggregatePriceResult.Builder.

entireSet

AggregatePriceSet entireSet()

The statistics from the collected oracle prices.

Returns:

An AggregatePriceSet.

trimmedSet

Optional<AggregatePriceSet> trimmedSet()

The trimmed statistics from the collected oracle prices. Only appears if the trim field was specified in the request.

Returns:

An Optional AggregatePriceSet.

medianString

String medianString()

The median price, as a String.

Returns:

A String.

median

@Lazy
default BigDecimal median()

Get the median price as a BigDecimal.

Returns:

A BigDecimal.

time

com.google.common.primitives.UnsignedInteger time()

The most recent timestamp out of all LastUpdateTime values.

Returns:

An UnsignedInteger.

ledgerHash

Optional<Hash256> ledgerHash()

The identifying Hash of the ledger version used to generate this response.

Returns:

A Hash256 containing the ledger hash.

ledgerHashSafe

@Auxiliary
default Hash256 ledgerHashSafe()

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

Returns:

The value of ledgerHash().

Throws:

IllegalStateException - If ledgerHash() is empty.

ledgerIndex

Optional<LedgerIndex> ledgerIndex()

The Ledger Index of the ledger version used to generate this response. Only present in responses to requests with ledger_index = "validated" or "closed".

Returns:

A 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.

ledgerCurrentIndex

Optional<LedgerIndex> ledgerCurrentIndex()

The ledger index of the current open ledger, which was used when retrieving this information. Only present in responses to requests with ledger_index = "current".

Returns:

An optionally-present LedgerIndex representing the current ledger index.

ledgerCurrentIndexSafe

@Auxiliary
default LedgerIndex ledgerCurrentIndexSafe()

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

Returns:

The value of ledgerCurrentIndex().

Throws:

IllegalStateException - If ledgerCurrentIndex() is empty.

validated

@Default
default boolean validated()

If true, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change.

Returns:

true if the information in this response comes from a validated ledger version, false if not.