Package org.xrpl.xrpl4j.model.client.path

Class ImmutableRipplePathFindRequestParams

    • Method Detail

      • withSourceAccount

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

      • withDestinationAccount

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

      • withDestinationAmount

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

      • withSendMax

        public final ImmutableRipplePathFindRequestParams withSendMax​(Optional<? extends CurrencyAmount> optional)
        Copy the current immutable object by setting an optional value for the sendMax 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 sendMax
        Returns:
        A modified copy of this object

      • withSourceCurrencies

        public final ImmutableRipplePathFindRequestParams withSourceCurrencies​(Iterable<? extends PathCurrency> elements)
        Copy the current immutable object with elements that replace the content of sourceCurrencies. A shallow reference equality check is used to prevent copying of the same value by returning this.
        Parameters:
        elements - An iterable of sourceCurrencies elements to set
        Returns:
        A modified copy of this object

      • withLedgerHash

        @Deprecated
public final ImmutableRipplePathFindRequestParams 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 ImmutableRipplePathFindRequestParams 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 ImmutableRipplePathFindRequestParams 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

      • equals

        public boolean equals​(@Nullable
                      Object another)
        This instance is equal to all instances of ImmutableRipplePathFindRequestParams 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: sourceAccount, destinationAccount, destinationAmount, sendMax, sourceCurrencies, ledgerSpecifier.
        Overrides:
        hashCode in class Object
        Returns:
        hashCode value

      • toString

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

      • builder

        public static ImmutableRipplePathFindRequestParams.Builder builder()
        Creates a builder for ImmutableRipplePathFindRequestParams. 
         ImmutableRipplePathFindRequestParams.builder()
    .sourceAccount(org.xrpl.xrpl4j.model.transactions.Address) // required sourceAccount
    .destinationAccount(org.xrpl.xrpl4j.model.transactions.Address) // required destinationAccount
    .destinationAmount(org.xrpl.xrpl4j.model.transactions.CurrencyAmount) // required destinationAmount
    .sendMax(org.xrpl.xrpl4j.model.transactions.CurrencyAmount) // optional sendMax
    .addSourceCurrencies|addAllSourceCurrencies(org.xrpl.xrpl4j.model.client.path.PathCurrency) // sourceCurrencies elements
    .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
    .build();
        Returns:
        A new ImmutableRipplePathFindRequestParams builder