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

Class ImmutableAccountObjectsRequestParams

    • Method Detail

      • deletionBlockersOnly

        public boolean deletionBlockersOnly()
        If true, the response only includes LedgerObjects that would block this account from being deleted. The default is false.
        Specified by:
        deletionBlockersOnly in interface AccountObjectsRequestParams
        Returns:
        true if requesting only ledger objects that would block this account from being deleted, otherwise false.

      • withAccount

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

      • withDeletionBlockersOnly

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

      • withLedgerHash

        @Deprecated
public final ImmutableAccountObjectsRequestParams 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 ImmutableAccountObjectsRequestParams 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 ImmutableAccountObjectsRequestParams 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 ImmutableAccountObjectsRequestParams 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 ImmutableAccountObjectsRequestParams 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 ImmutableAccountObjectsRequestParams 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 ImmutableAccountObjectsRequestParams 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 ImmutableAccountObjectsRequestParams 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, type, deletionBlockersOnly, ledgerSpecifier, limit, marker.
        Overrides:
        hashCode in class Object
        Returns:
        hashCode value

      • toString

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

      • builder

        public static ImmutableAccountObjectsRequestParams.Builder builder()
        Creates a builder for ImmutableAccountObjectsRequestParams. 
         ImmutableAccountObjectsRequestParams.builder()
    .account(org.xrpl.xrpl4j.model.transactions.Address) // required account
    .type(org.xrpl.xrpl4j.model.client.accounts.AccountObjectsRequestParams.AccountObjectType) // optional type
    .deletionBlockersOnly(boolean) // optional deletionBlockersOnly
    .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 ImmutableAccountObjectsRequestParams builder