Class PaymentChannelClaimFlags
TransactionFlags which can be set on PaymentChannelClaim transactions.-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final PaymentChannelClaimFlagsConstantPaymentChannelClaimFlagsfor thetfCloseflag.static final PaymentChannelClaimFlagsConstantPaymentChannelClaimFlagsfor thetfInnerBatchTxnflag.protected static final PaymentChannelClaimFlagsConstantPaymentChannelClaimFlagsfor thetfRenewflag.Fields inherited from class org.xrpl.xrpl4j.model.flags.TransactionFlags
EMPTY, FULLY_CANONICAL_SIG, UNSET -
Method Summary
Modifier and TypeMethodDescriptionbuilder()Create a newPaymentChannelClaimFlags.Builder.static PaymentChannelClaimFlagsempty()Construct an empty instance ofPaymentChannelClaimFlags.static PaymentChannelClaimFlagsof(long value) ConstructPaymentChannelClaimFlagswith a given value.booleantfClose()Request to close the channel.booleanRequire a fully canonical transaction signature.booleanWhether thetfInnerBatchTxnflag is set.booleantfRenew()Clear thePayChannelObject.expiration()time (different fromPayChannelObject.cancelAfter()time.) Only the source address of the payment channel can use this flag.
-
Field Details
-
RENEW
ConstantPaymentChannelClaimFlagsfor thetfRenewflag. -
CLOSE
ConstantPaymentChannelClaimFlagsfor thetfCloseflag. -
INNER_BATCH_TXN
ConstantPaymentChannelClaimFlagsfor thetfInnerBatchTxnflag.
-
-
Method Details
-
builder
Create a newPaymentChannelClaimFlags.Builder.- Returns:
- A new
PaymentChannelClaimFlags.Builder.
-
of
ConstructPaymentChannelClaimFlagswith a given value.- Parameters:
value- The long-number encoded flags value of thisPaymentChannelClaimFlags.- Returns:
- New
PaymentChannelClaimFlags.
-
empty
Construct an empty instance ofPaymentChannelClaimFlags. Transactions with empty flags will not be serialized with aFlagsfield.- Returns:
- An empty
PaymentChannelClaimFlags.
-
tfFullyCanonicalSig
public boolean tfFullyCanonicalSig()Require a fully canonical transaction signature.- Overrides:
tfFullyCanonicalSigin classTransactionFlags- Returns:
trueiftfFullyCanonicalSigis set, otherwisefalse.- See Also:
-
tfRenew
public boolean tfRenew()Clear thePayChannelObject.expiration()time (different fromPayChannelObject.cancelAfter()time.) Only the source address of the payment channel can use this flag.- Returns:
trueiftfRenewis set, otherwisefalse.
-
tfClose
public boolean tfClose()Request to close the channel.Only the
PayChannelObject.account()andPayChannelObject.destination()addresses can use this flag.This flag closes the channel immediately if it has no more XRP allocated to it after processing the current claim, or if the
PayChannelObject.destination()address uses it. If the source address uses this flag when the channel still holds XRP, this schedules the channel to close afterPayChannelObject.settleDelay()seconds have passed. (Specifically, this sets thePayChannelObject.expiration()of the channel to the close time of the previous ledger plus the channel'sPayChannelObject.settleDelay()time, unless the channel already has an earlierPayChannelObject.expiration()time.)If the
PayChannelObject.destination()address uses this flag when the channel still holds XRP, any XRP that remains after processing the claim is returned to the source address.- Returns:
trueiftfFullyCanonicalSigis set, otherwisefalse.
-
tfInnerBatchTxn
public boolean tfInnerBatchTxn()Whether thetfInnerBatchTxnflag is set.- Overrides:
tfInnerBatchTxnin classTransactionFlags- Returns:
trueiftfInnerBatchTxnis set, otherwisefalse.- See Also:
-