Package org.xrpl.xrpl4j.model.flags
Class MpTokenIssuanceFlags
java.lang.Object
org.xrpl.xrpl4j.model.flags.Flags
org.xrpl.xrpl4j.model.flags.MpTokenIssuanceFlags
A set of static
Flags which can be set on MpTokenIssuanceObjects.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final MpTokenIssuanceFlagsConstantMpTokenIssuanceFlagsfor thelsfMPTCanClawbackaccount flag.static final MpTokenIssuanceFlagsConstantMpTokenIssuanceFlagsfor thelsfMPTCanEscrowaccount flag.static final MpTokenIssuanceFlagsConstantMpTokenIssuanceFlagsfor thelsfMPTCanLockaccount flag.static final MpTokenIssuanceFlagsConstantMpTokenIssuanceFlagsfor thelsfMPTCanTradeaccount flag.static final MpTokenIssuanceFlagsConstantMpTokenIssuanceFlagsfor thelsfMPTCanTransferaccount flag.static final MpTokenIssuanceFlagsConstantMpTokenIssuanceFlagsfor thelsfMPTLockedaccount flag.static final MpTokenIssuanceFlagsConstantMpTokenIssuanceFlagsfor thelsfMPTRequireAuthaccount flag.static final MpTokenIssuanceFlagsConstant for an unset flag. -
Method Summary
Modifier and TypeMethodDescriptionbooleanIf set, indicates that the issuer may use the Clawback transaction to clawback value from individual holders.booleanIf set, indicates that individual holders can place their balances into an escrow.booleanIf set, indicates that the issuer can lock an individual balance or all balances of this MPT.booleanIf set, indicates that individual holders can trade their balances using the XRP Ledger DEX or AMM.booleanIf set, indicates that tokens held by non-issuers may be transferred to other accounts.booleanIf set, indicates that all balances are locked.booleanIf set, indicates that individual holders must be authorized.static MpTokenIssuanceFlagsof(long value) ConstructMpTokenIssuanceFlagswith a given value.
-
Field Details
-
UNSET
Constant for an unset flag. -
LOCKED
ConstantMpTokenIssuanceFlagsfor thelsfMPTLockedaccount flag. -
CAN_LOCK
ConstantMpTokenIssuanceFlagsfor thelsfMPTCanLockaccount flag. -
REQUIRE_AUTH
ConstantMpTokenIssuanceFlagsfor thelsfMPTRequireAuthaccount flag. -
CAN_ESCROW
ConstantMpTokenIssuanceFlagsfor thelsfMPTCanEscrowaccount flag. -
CAN_TRADE
ConstantMpTokenIssuanceFlagsfor thelsfMPTCanTradeaccount flag. -
CAN_TRANSFER
ConstantMpTokenIssuanceFlagsfor thelsfMPTCanTransferaccount flag. -
CAN_CLAWBACK
ConstantMpTokenIssuanceFlagsfor thelsfMPTCanClawbackaccount flag.
-
-
Method Details
-
of
ConstructMpTokenIssuanceFlagswith a given value.- Parameters:
value- The long-number encoded flags value of thisMpTokenIssuanceFlags.- Returns:
- New
MpTokenIssuanceFlags.
-
lsfMptLocked
public boolean lsfMptLocked()If set, indicates that all balances are locked.- Returns:
trueiflsfMPTLockedis set, otherwisefalse.
-
lsfMptCanLock
public boolean lsfMptCanLock()If set, indicates that the issuer can lock an individual balance or all balances of this MPT. If not set, the MPT cannot be locked in any way.- Returns:
trueiflsfMPTCanLockis set, otherwisefalse.
-
lsfMptRequireAuth
public boolean lsfMptRequireAuth()If set, indicates that individual holders must be authorized. This enables issuers to limit who can hold their assets.- Returns:
trueiflsfMPTRequireAuthis set, otherwisefalse.
-
lsfMptCanEscrow
public boolean lsfMptCanEscrow()If set, indicates that individual holders can place their balances into an escrow.- Returns:
trueiflsfMPTCanEscrowis set, otherwisefalse.
-
lsfMptCanTrade
public boolean lsfMptCanTrade()If set, indicates that individual holders can trade their balances using the XRP Ledger DEX or AMM.- Returns:
trueiflsfMPTCanTradeis set, otherwisefalse.
-
lsfMptCanTransfer
public boolean lsfMptCanTransfer()If set, indicates that tokens held by non-issuers may be transferred to other accounts. If not set, indicates that tokens held by non-issuers may not be transferred except back to the issuer; this enables use-cases like store credit.- Returns:
trueiflsfMPTCanTransferis set, otherwisefalse.
-
lsfMptCanClawback
public boolean lsfMptCanClawback()If set, indicates that the issuer may use the Clawback transaction to clawback value from individual holders.- Returns:
trueiflsfMPTCanClawbackis set, otherwisefalse.
-