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:
-
Method Summary
Modifier and TypeMethodDescriptionaccount()static ImmutablePathStep.Builderbuilder()Construct a builder for this class.currency()If present, thisPathSteprepresents changing currencies through an order book.issuer()If present, this path step represents changing currencies and this address defines the issuer of the new currency.
-
Method Details
-
builder
Construct a builder for this class.- Returns:
- An
ImmutablePathStep.Builder.
-
account
If present, thisPathSteprepresents rippling through the specifiedAddress. MUST NOT be provided if thisPathStepspecifies thecurrency()orissuer()fields. -
currency
-
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 theaccount()field.
-