Package org.xrpl.xrpl4j.model.flags
Class PaymentFlags
java.lang.Object
org.xrpl.xrpl4j.model.flags.Flags
org.xrpl.xrpl4j.model.flags.TransactionFlags
org.xrpl.xrpl4j.model.flags.PaymentFlags
A set of static
TransactionFlags which can be set on Payment transactions.-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final PaymentFlagsConstantPaymentFlagsfor thetfInnerBatchTxnflag.protected static final PaymentFlagsConstantPaymentFlagsfor thetfLimitQualityflag.protected static final PaymentFlagsConstantPaymentFlagsfor thetfNoDirectRippleflag.protected static final PaymentFlagsConstantPaymentFlagsfor thetfPartialPaymentflag.static final PaymentFlagsConstantPaymentFlagsfor an unset flag.Fields inherited from class org.xrpl.xrpl4j.model.flags.TransactionFlags
EMPTY, FULLY_CANONICAL_SIG -
Method Summary
Modifier and TypeMethodDescriptionstatic PaymentFlags.Builderbuilder()Create a newPaymentFlags.Builder.static PaymentFlagsempty()Construct an empty instance ofPaymentFlags.static PaymentFlagsof(long value) ConstructPaymentFlagswith a given value.booleanIndicates that this transaction is an inner transaction of a Batch transaction.booleanOnly take paths where all the conversions have an input:output ratio that is equal or better than the ratio ofPayment.amount():Payment.sendMax().booleanDo not use the default path; only use paths included in thePayment.paths()field.booleanIf the specifiedPayment.amount()cannot be sent without spending more thanPayment.sendMax(), reduce the received amount instead of failing outright.Methods inherited from class org.xrpl.xrpl4j.model.flags.TransactionFlags
tfFullyCanonicalSig
-
Field Details
-
UNSET
ConstantPaymentFlagsfor an unset flag. -
NO_DIRECT_RIPPLE
ConstantPaymentFlagsfor thetfNoDirectRippleflag. -
PARTIAL_PAYMENT
ConstantPaymentFlagsfor thetfPartialPaymentflag. -
LIMIT_QUALITY
ConstantPaymentFlagsfor thetfLimitQualityflag. -
INNER_BATCH_TXN
ConstantPaymentFlagsfor thetfInnerBatchTxnflag. This flag is used to indicate that a transaction is an inner transaction of a Batch.- See Also:
-
-
Method Details
-
builder
Create a newPaymentFlags.Builder.- Returns:
- A new
PaymentFlags.Builder.
-
of
ConstructPaymentFlagswith a given value.- Parameters:
value- The long-number encoded flags value of thisPaymentFlags.- Returns:
- New
PaymentFlags.
-
empty
Construct an empty instance ofPaymentFlags. Transactions with empty flags will not be serialized with aFlagsfield.- Returns:
- An empty
PaymentFlags.
-
tfNoDirectRipple
public boolean tfNoDirectRipple()Do not use the default path; only use paths included in thePayment.paths()field. This is intended to force the transaction to take arbitrage opportunities. Most clients do not need this.- Returns:
trueiftfNoDirectRippleis set, otherwisefalse.
-
tfPartialPayment
public boolean tfPartialPayment()If the specifiedPayment.amount()cannot be sent without spending more thanPayment.sendMax(), reduce the received amount instead of failing outright.- Returns:
trueiftfPartialPaymentis set, otherwisefalse.- See Also:
-
tfLimitQuality
public boolean tfLimitQuality()Only take paths where all the conversions have an input:output ratio that is equal or better than the ratio ofPayment.amount():Payment.sendMax().- Returns:
trueiftfLimitQualityis set, otherwisefalse.
-
tfInnerBatchTxn
public boolean tfInnerBatchTxn()Indicates that this transaction is an inner transaction of a Batch transaction.- Overrides:
tfInnerBatchTxnin classTransactionFlags- Returns:
trueiftfInnerBatchTxnis set, otherwisefalse.- See Also:
-