Package org.xrpl.xrpl4j.model.flags
Class AccountRootFlags
java.lang.Object
org.xrpl.xrpl4j.model.flags.Flags
org.xrpl.xrpl4j.model.flags.AccountRootFlags
A set of static
Flags which can be set on AccountSet transactions.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final AccountRootFlagsConstantAccountRootFlagsfor thelsfAllowTrustLineClawbackaccount flag.static final AccountRootFlagsConstantAccountRootFlagsfor thelsfAllowTrustLineLockingaccount flag.static final AccountRootFlagsConstantAccountRootFlagsfor thelsfDefaultRippleaccount flag.static final AccountRootFlagsConstantAccountRootFlagsfor thelsfDepositAuthaccount flag.static final AccountRootFlagsConstantAccountRootFlagsfor thelsfDisableMasteraccount flag.static final AccountRootFlagsConstantAccountRootFlagsfor thelsfDisallowIncomingCheckaccount flag.static final AccountRootFlagsConstantAccountRootFlagsfor thelsfDisallowIncomingNFTokenOfferaccount flag.static final AccountRootFlagsConstantAccountRootFlagsfor thelsfDisallowIncomingPayChanaccount flag.static final AccountRootFlagsConstantAccountRootFlagsfor thelsfDisallowIncomingTrustlineaccount flag.static final AccountRootFlagsConstantAccountRootFlagsfor thelsfDisallowXRPaccount flag.static final AccountRootFlagsConstantAccountRootFlagsfor thelsfGlobalFreezeaccount flag.static final AccountRootFlagsConstantAccountRootFlagsfor thelsfNoFreezeaccount flag.static final AccountRootFlagsConstantAccountRootFlagsfor thelsfPasswordSpentaccount flag.static final AccountRootFlagsConstantAccountRootFlagsfor thelsfRequireAuthaccount flag.static final AccountRootFlagsConstantAccountRootFlagsfor thelsfRequireDestTagaccount flag.static final AccountRootFlagsConstant for an unset flag. -
Method Summary
Modifier and TypeMethodDescriptionbooleanAllows trustline clawback on this account.booleanAllows trust line tokens (IOUs) issued by this account to be held in escrow.booleanEnable rippling on this addresses's trust lines by default.booleanThis account can only receive funds from transactions it sends, and from preauthorized accounts.booleanDisallows use of the master key to sign transactions for this account.booleanBlocks incoming Checks.booleanBlocks incoming NFToken Offers.booleanBlocks incoming Payment Channels.booleanBlocks incoming Trustlines.booleanClient applications should not send XRP to this account.booleanAll assets issued by this address are frozen.booleanThis address cannot freeze trust lines connected to it.booleanThe account has used its free SetRegularKey transaction.booleanThis account must individually approve other users for those users to hold this account's issued currencies.booleanRequires incoming payments to specify a Destination Tag.static AccountRootFlagsof(long value) ConstructAccountRootFlagswith a given value.
-
Field Details
-
UNSET
Constant for an unset flag. -
DEFAULT_RIPPLE
ConstantAccountRootFlagsfor thelsfDefaultRippleaccount flag. -
DEPOSIT_AUTH
ConstantAccountRootFlagsfor thelsfDepositAuthaccount flag. -
DISABLE_MASTER
ConstantAccountRootFlagsfor thelsfDisableMasteraccount flag. -
DISALLOW_XRP
ConstantAccountRootFlagsfor thelsfDisallowXRPaccount flag. -
GLOBAL_FREEZE
ConstantAccountRootFlagsfor thelsfGlobalFreezeaccount flag. -
NO_FREEZE
ConstantAccountRootFlagsfor thelsfNoFreezeaccount flag. -
PASSWORD_SPENT
ConstantAccountRootFlagsfor thelsfPasswordSpentaccount flag. -
REQUIRE_AUTH
ConstantAccountRootFlagsfor thelsfRequireAuthaccount flag. -
REQUIRE_DEST_TAG
ConstantAccountRootFlagsfor thelsfRequireDestTagaccount flag. -
DISALLOW_INCOMING_NFT_OFFER
ConstantAccountRootFlagsfor thelsfDisallowIncomingNFTokenOfferaccount flag. -
DISALLOW_INCOMING_CHECK
ConstantAccountRootFlagsfor thelsfDisallowIncomingCheckaccount flag. -
DISALLOW_INCOMING_PAY_CHAN
ConstantAccountRootFlagsfor thelsfDisallowIncomingPayChanaccount flag. -
DISALLOW_INCOMING_TRUSTLINE
ConstantAccountRootFlagsfor thelsfDisallowIncomingTrustlineaccount flag. -
ALLOW_TRUSTLINE_CLAWBACK
ConstantAccountRootFlagsfor thelsfAllowTrustLineClawbackaccount flag.This constant will be marked
Betauntil the Clawback amendment is enabled on mainnet. Its API is subject to change. -
ALLOW_TRUSTLINE_LOCKING
ConstantAccountRootFlagsfor thelsfAllowTrustLineLockingaccount flag.This constant will be marked
Betauntil the TokenEscrow amendment is enabled on mainnet. Its API is subject to change.
-
-
Method Details
-
of
ConstructAccountRootFlagswith a given value.- Parameters:
value- The long-number encoded flags value of thisAccountRootFlags.- Returns:
- New
AccountRootFlags.
-
lsfDefaultRipple
public boolean lsfDefaultRipple()Enable rippling on this addresses's trust lines by default. Required for issuing addresses; discouraged for others.- Returns:
trueiflsfDefaultRippleis set, otherwisefalse.
-
lsfDepositAuth
public boolean lsfDepositAuth()This account can only receive funds from transactions it sends, and from preauthorized accounts. (It has DepositAuth enabled.)- Returns:
trueiflsfDepositAuthis set, otherwisefalse.
-
lsfDisableMaster
public boolean lsfDisableMaster()Disallows use of the master key to sign transactions for this account.- Returns:
trueiflsfDisableMasteris set, otherwisefalse.
-
lsfDisallowXrp
public boolean lsfDisallowXrp()Client applications should not send XRP to this account. Not enforced by rippled.- Returns:
trueiflsfDisallowXrpis set, otherwisefalse.
-
lsfGlobalFreeze
public boolean lsfGlobalFreeze()All assets issued by this address are frozen.- Returns:
trueiflsfGlobalFreezeis set, otherwisefalse.
-
lsfNoFreeze
public boolean lsfNoFreeze()This address cannot freeze trust lines connected to it. Once enabled, cannot be disabled.- Returns:
trueiflsfNoFreezeis set, otherwisefalse.
-
lsfPasswordSpent
public boolean lsfPasswordSpent()The account has used its free SetRegularKey transaction.- Returns:
trueiflsfPasswordSpentis set, otherwisefalse.
-
lsfRequireAuth
public boolean lsfRequireAuth()This account must individually approve other users for those users to hold this account's issued currencies.- Returns:
trueiflsfRequireAuthis set, otherwisefalse.
-
lsfRequireDestTag
public boolean lsfRequireDestTag()Requires incoming payments to specify a Destination Tag.- Returns:
trueiflsfRequireDestTagis set, otherwisefalse.
-
lsfDisallowIncomingNFTokenOffer
public boolean lsfDisallowIncomingNFTokenOffer()Blocks incoming NFToken Offers.- Returns:
trueiflsfDisallowIncomingNFTokenOfferis set, otherwisefalse.
-
lsfDisallowIncomingCheck
public boolean lsfDisallowIncomingCheck()Blocks incoming Checks.- Returns:
trueiflsfDisallowIncomingCheckis set, otherwisefalse.
-
lsfDisallowIncomingPayChan
public boolean lsfDisallowIncomingPayChan()Blocks incoming Payment Channels.- Returns:
trueiflsfDisallowIncomingPayChanis set, otherwisefalse.
-
lsfDisallowIncomingTrustline
public boolean lsfDisallowIncomingTrustline()Blocks incoming Trustlines.- Returns:
trueiflsfDisallowIncomingTrustlineis set, otherwisefalse.
-
lsfAllowTrustLineClawback
@Beta public boolean lsfAllowTrustLineClawback()Allows trustline clawback on this account.This constant will be marked
Betauntil the Clawback amendment is enabled on mainnet. Its API is subject to change.- Returns:
trueiflsfAllowTrustLineClawbackis set, otherwisefalse.
-
lsfAllowTrustLineLocking
@Beta public boolean lsfAllowTrustLineLocking()Allows trust line tokens (IOUs) issued by this account to be held in escrow.This constant will be marked
Betauntil the TokenEscrow amendment is enabled on mainnet. Its API is subject to change.- Returns:
trueiflsfAllowTrustLineLockingis set, otherwisefalse.
-