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

Class ImmutableAccountOffersRequestParams

    • Method Detail

      • strict

        public boolean strict()
        A boolean indicating if the account() field only accepts a public key or XRP Ledger Address. Always true, as account() is always an Address.
        Specified by:
        strict in interface AccountOffersRequestParams
        Returns:
        true if the account field only accepts a public key or XRP Ledger address, otherwise false. Defaults to true.

      • limit

        public Optional<com.google.common.primitives.UnsignedInteger> limit()
        Limit the number of transactions to retrieve. Cannot be less than 10 or more than 400. The server is not required to honor this value and the default varies.
        Specified by:
        limit in interface AccountOffersRequestParams
        Returns:
        An optionally-present UnsignedInteger.

      • withAccount

        public final ImmutableAccountOffersRequestParams 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

      • withLedgerHash

        @Deprecated
public final ImmutableAccountOffersRequestParams 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 ImmutableAccountOffersRequestParams withLedgerIndex​(@Nullable
                                                                 LedgerIndex value)
        Deprecated.
        Copy the current immutable object by setting a value for the ledgerIndex attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        value - A new value for ledgerIndex (can be null)
        Returns:
        A modified copy of the this object

      • withLedgerSpecifier

        public final ImmutableAccountOffersRequestParams withLedgerSpecifier​(LedgerSpecifier value)
        Copy the current immutable object by setting a value for the ledgerSpecifier attribute. A shallow reference equality check is 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

      • withLimit

        public final ImmutableAccountOffersRequestParams 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 ImmutableAccountOffersRequestParams 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 ImmutableAccountOffersRequestParams 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 ImmutableAccountOffersRequestParams 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 ImmutableAccountOffersRequestParams 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, ledgerSpecifier, strict, limit, marker.
        Overrides:
        hashCode in class Object
        Returns:
        hashCode value

      • toString

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

      • builder

        public static ImmutableAccountOffersRequestParams.Builder builder()
        Creates a builder for ImmutableAccountOffersRequestParams. 
         ImmutableAccountOffersRequestParams.builder()
    .account(org.xrpl.xrpl4j.model.transactions.Address) // required account
    .ledgerHash(org.xrpl.xrpl4j.model.transactions.Hash256) // optional ledgerHash
    .ledgerIndex(org.xrpl.xrpl4j.model.client.common.LedgerIndex | null) // nullable ledgerIndex
    .ledgerSpecifier(org.xrpl.xrpl4j.model.client.common.LedgerSpecifier) // optional ledgerSpecifier
    .limit(com.google.common.primitives.UnsignedInteger) // optional limit
    .marker(org.xrpl.xrpl4j.model.transactions.Marker) // optional marker
    .build();
        Returns:
        A new ImmutableAccountOffersRequestParams builder