Interface PathStep

All Known Implementing Classes:
ImmutablePathStep

@Immutable public interface PathStep
A step in a Path for cross-currency payments on the XRP Ledger.
See Also:
  • "https://xrpl.org/paths.html"
  • Method Details

    • builder

      static ImmutablePathStep.Builder builder()
      Construct a builder for this class.
      Returns:
      An ImmutablePathStep.Builder.
    • account

      Optional<Address> account()
      If present, this PathStep represents rippling through the specified Address. MUST NOT be provided if this PathStep specifies the currency() or issuer() fields.
      Returns:
      An Optional of type Address.
    • currency

      Optional<String> currency()
      If present, this PathStep represents changing currencies through an order book. The currency specified indicates the new currency. MUST NOT be provided if this PathStep specifies the account() field.
      Returns:
      An Optional of type String containing the currency code.
    • issuer

      Optional<Address> issuer()
      If present, this path step represents changing currencies and this address defines the issuer of the new currency. If omitted in a step with a non-XRP currency, a previous step of the path defines the issuer. If present when currency is omitted, indicates a path step that uses an order book between same-named currencies with different issuers. MUST be omitted if the currency is XRP. MUST NOT be provided if this step specifies the account() field.
      Returns:
      The Optional Address of the currency issuer.