Package org.xrpl.xrpl4j.model.client.accounts

Class ImmutableAccountTransactionsRequestParams

    • Method Detail

      • binary

        public boolean binary()
        Whether or not to return transactions as JSON or binary-encoded hex strings. Always false.
        Specified by:
        binary in interface AccountTransactionsRequestParams
        Returns:
        Always false.

      • forward

        public boolean forward()
        If set to true, returns values indexed with the oldest ledger first. Otherwise, the results are indexed with the newest ledger first. (Each page of results may not be internally ordered, but the pages are overall ordered.)
        Specified by:
        forward in interface AccountTransactionsRequestParams
        Returns:
        true if values should be indexed with the oldest ledger first, otherwise false. Defaults to false.

      • limit

        public Optional<com.google.common.primitives.UnsignedInteger> limit()
        Limit the number of transactions to retrieve. The server is not required to honor this value.
        Specified by:
        limit in interface AccountTransactionsRequestParams
        Returns:
        An optionally-present UnsignedInteger representing the number of transactions to return.

      • marker

        public Optional<Marker> marker()
        Value from a previous paginated response. Resume retrieving data where that response left off. This value is stable even if there is a change in the server's range of available ledgers.
        Specified by:
        marker in interface AccountTransactionsRequestParams
        Returns:
        An optionally-present String containing the marker.

      • withAccount

        public final ImmutableAccountTransactionsRequestParams withAccount​(Address value)
        Copy the current immutable object by setting a value for the account attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for account
        Returns:
        A modified copy of the this object

      • withLedgerIndexMin

        @Deprecated
public final ImmutableAccountTransactionsRequestParams withLedgerIndexMin​(Optional<? extends LedgerIndex> optional)
        Deprecated.
        Copy the current immutable object by setting an optional value for the ledgerIndexMin attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for ledgerIndexMin
        Returns:
        A modified copy of this object

      • withLedgerIndexMax

        @Deprecated
public final ImmutableAccountTransactionsRequestParams withLedgerIndexMax​(Optional<? extends LedgerIndex> optional)
        Deprecated.
        Copy the current immutable object by setting an optional value for the ledgerIndexMax attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for ledgerIndexMax
        Returns:
        A modified copy of this object

      • withLedgerIndexMinimum

        public final ImmutableAccountTransactionsRequestParams withLedgerIndexMinimum​(@Nullable
                                                                              LedgerIndexBound value)
        Copy the current immutable object by setting a value for the ledgerIndexMinimum attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for ledgerIndexMinimum (can be null)
        Returns:
        A modified copy of the this object

      • withLedgerIndexMaximum

        public final ImmutableAccountTransactionsRequestParams withLedgerIndexMaximum​(@Nullable
                                                                              LedgerIndexBound value)
        Copy the current immutable object by setting a value for the ledgerIndexMaximum attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for ledgerIndexMaximum (can be null)
        Returns:
        A modified copy of the this object

      • withLedgerHash

        @Deprecated
public final ImmutableAccountTransactionsRequestParams withLedgerHash​(Optional<? extends Hash256> optional)
        Deprecated.
        Copy the current immutable object by setting an optional value for the ledgerHash attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for ledgerHash
        Returns:
        A modified copy of this object

      • withLedgerIndex

        @Deprecated
public final ImmutableAccountTransactionsRequestParams withLedgerIndex​(Optional<? extends LedgerIndex> optional)
        Deprecated.
        Copy the current immutable object by setting an optional value for the ledgerIndex attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for ledgerIndex
        Returns:
        A modified copy of this object

      • withLedgerSpecifier

        public final ImmutableAccountTransactionsRequestParams withLedgerSpecifier​(Optional<LedgerSpecifier> value)
        Copy the current immutable object by setting a value for the ledgerSpecifier attribute. An equals check used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for ledgerSpecifier
        Returns:
        A modified copy of the this object

      • withForward

        public final ImmutableAccountTransactionsRequestParams withForward​(boolean value)
        Copy the current immutable object by setting a value for the forward attribute. A value equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for forward
        Returns:
        A modified copy of the this object

      • withLimit

        public final ImmutableAccountTransactionsRequestParams withLimit​(com.google.common.primitives.UnsignedInteger value)
        Copy the current immutable object by setting a present value for the optional limit attribute.
        Parameters:
        value - The value for limit
        Returns:
        A modified copy of this object

      • withLimit

        public final ImmutableAccountTransactionsRequestParams withLimit​(Optional<? extends com.google.common.primitives.UnsignedInteger> optional)
        Copy the current immutable object by setting an optional value for the limit attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for limit
        Returns:
        A modified copy of this object

      • withMarker

        public final ImmutableAccountTransactionsRequestParams withMarker​(Marker value)
        Copy the current immutable object by setting a present value for the optional marker attribute.
        Parameters:
        value - The value for marker
        Returns:
        A modified copy of this object

      • withMarker

        public final ImmutableAccountTransactionsRequestParams withMarker​(Optional<? extends Marker> optional)
        Copy the current immutable object by setting an optional value for the marker attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
        Parameters:
        optional - A value for marker
        Returns:
        A modified copy of this object

      • equals

        public boolean equals​(@Nullable
                      Object another)
        This instance is equal to all instances of ImmutableAccountTransactionsRequestParams that have equal attribute values.
        Overrides:
        equals in class Object
        Returns:
        true if this is equal to another instance

      • hashCode

        public int hashCode()
        Computes a hash code from attributes: account, ledgerIndexMinimum, ledgerIndexMaximum, ledgerSpecifier, binary, forward, limit, marker.
        Overrides:
        hashCode in class Object
        Returns:
        hashCode value

      • toString

        public String toString()
        Prints the immutable value AccountTransactionsRequestParams with attribute values.
        Overrides:
        toString in class Object
        Returns:
        A string representation of the value

      • builder

        public static ImmutableAccountTransactionsRequestParams.Builder builder()
        Creates a builder for ImmutableAccountTransactionsRequestParams. 
         ImmutableAccountTransactionsRequestParams.builder()
    .account(org.xrpl.xrpl4j.model.transactions.Address) // required account
    .ledgerIndexMin(org.xrpl.xrpl4j.model.client.common.LedgerIndex) // optional ledgerIndexMin
    .ledgerIndexMax(org.xrpl.xrpl4j.model.client.common.LedgerIndex) // optional ledgerIndexMax
    .ledgerIndexMinimum(org.xrpl.xrpl4j.model.client.common.LedgerIndexBound | null) // nullable ledgerIndexMinimum
    .ledgerIndexMaximum(org.xrpl.xrpl4j.model.client.common.LedgerIndexBound | null) // nullable ledgerIndexMaximum
    .ledgerHash(org.xrpl.xrpl4j.model.transactions.Hash256) // optional ledgerHash
    .ledgerIndex(org.xrpl.xrpl4j.model.client.common.LedgerIndex) // optional ledgerIndex
    .ledgerSpecifier(Optional&lt;org.xrpl.xrpl4j.model.client.common.LedgerSpecifier&gt;) // optional ledgerSpecifier
    .forward(boolean) // optional forward
    .limit(com.google.common.primitives.UnsignedInteger) // optional limit
    .marker(org.xrpl.xrpl4j.model.transactions.Marker) // optional marker
    .build();
        Returns:
        A new ImmutableAccountTransactionsRequestParams builder