Package org.xrpl.xrpl4j.model.flags
Class AmmWithdrawFlags
java.lang.Object
org.xrpl.xrpl4j.model.flags.Flags
org.xrpl.xrpl4j.model.flags.TransactionFlags
org.xrpl.xrpl4j.model.flags.AmmWithdrawFlags
A set of
TransactionFlags that can be set on AmmWithdraw
transactions. Exactly one flag must be set on each AmmWithdraw
transaction, so this class does not allow for combination of multiple flags.
While most other TransactionFlags support empty flags or 0, AmmWithdraw transactions must have a Flags field to denote the withdraw mode. Therefore, AmmWithdrawFlags does not support empty or unset flags.
This class will be marked Beta until the AMM amendment is enabled on mainnet. Its API is subject to
change.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.xrpl.xrpl4j.model.flags.TransactionFlags
TransactionFlags.Builder -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final AmmWithdrawFlagsConstantAmmWithdrawFlagsfor thetfInnerBatchTxnflag.static final AmmWithdrawFlagsConstantAmmWithdrawFlagsfor thetfLimitLPTokenflag.static final AmmWithdrawFlagsConstantAmmWithdrawFlagsfor thetfLPTokenflag.static final AmmWithdrawFlagsConstantAmmWithdrawFlagsfor thetfOneAssetLPTokenflag.static final AmmWithdrawFlagsConstantAmmWithdrawFlagsfor thetfOneAssetWithdrawAllflag.static final AmmWithdrawFlagsConstantAmmWithdrawFlagsfor thetfSingleAssetflag.static final AmmWithdrawFlagsConstantAmmWithdrawFlagsfor thetfTwoAssetflag.static final AmmWithdrawFlagsConstantAmmWithdrawFlagsfor thetfWithdrawAllflag.Fields inherited from class org.xrpl.xrpl4j.model.flags.TransactionFlags
EMPTY, FULLY_CANONICAL_SIG, UNSET -
Method Summary
Modifier and TypeMethodDescriptionbooleanWhether thetfInnerBatchTxnflag is set.booleanWhether thetfLimitLPTokenflag is set.booleanWhether thetfLPTokenflag is set.booleanWhether thetfOneAssetLPTokenflag is set.booleanWhether thetfOneAssetWithdrawAllflag is set.booleanWhether thetfSingleAssetflag is set.booleanWhether thetfTwoAssetflag is set.booleanWhether thetfWithdrawAllflag is set.Methods inherited from class org.xrpl.xrpl4j.model.flags.TransactionFlags
of, tfFullyCanonicalSig
-
Field Details
-
LP_TOKEN
ConstantAmmWithdrawFlagsfor thetfLPTokenflag. -
WITHDRAW_ALL
ConstantAmmWithdrawFlagsfor thetfWithdrawAllflag. -
ONE_ASSET_WITHDRAW_ALL
ConstantAmmWithdrawFlagsfor thetfOneAssetWithdrawAllflag. -
SINGLE_ASSET
ConstantAmmWithdrawFlagsfor thetfSingleAssetflag. -
TWO_ASSET
ConstantAmmWithdrawFlagsfor thetfTwoAssetflag. -
ONE_ASSET_LP_TOKEN
ConstantAmmWithdrawFlagsfor thetfOneAssetLPTokenflag. -
LIMIT_LP_TOKEN
ConstantAmmWithdrawFlagsfor thetfLimitLPTokenflag. -
INNER_BATCH_TXN
ConstantAmmWithdrawFlagsfor thetfInnerBatchTxnflag.
-
-
Method Details
-
tfLpToken
public boolean tfLpToken()Whether thetfLPTokenflag is set.- Returns:
trueiftfLPTokenis set, otherwisefalse.
-
tfWithdrawAll
public boolean tfWithdrawAll()Whether thetfWithdrawAllflag is set.- Returns:
trueiftfWithdrawAllis set, otherwisefalse.
-
tfOneAssetWithdrawAll
public boolean tfOneAssetWithdrawAll()Whether thetfOneAssetWithdrawAllflag is set.- Returns:
trueiftfOneAssetWithdrawAllis set, otherwisefalse.
-
tfSingleAsset
public boolean tfSingleAsset()Whether thetfSingleAssetflag is set.- Returns:
trueiftfSingleAssetis set, otherwisefalse.
-
tfTwoAsset
public boolean tfTwoAsset()Whether thetfTwoAssetflag is set.- Returns:
trueiftfTwoAssetis set, otherwisefalse.
-
tfOneAssetLpToken
public boolean tfOneAssetLpToken()Whether thetfOneAssetLPTokenflag is set.- Returns:
trueiftfOneAssetLPTokenis set, otherwisefalse.
-
tfLimitLpToken
public boolean tfLimitLpToken()Whether thetfLimitLPTokenflag is set.- Returns:
trueiftfLimitLPTokenis set, otherwisefalse.
-
tfInnerBatchTxn
public boolean tfInnerBatchTxn()Whether thetfInnerBatchTxnflag is set.- Overrides:
tfInnerBatchTxnin classTransactionFlags- Returns:
trueiftfInnerBatchTxnis set, otherwisefalse.- See Also:
-