Enum AccountSet.AccountSetFlag
java.lang.Object
java.lang.Enum<AccountSet.AccountSetFlag>
org.xrpl.xrpl4j.model.transactions.AccountSet.AccountSetFlag
- All Implemented Interfaces:
Serializable,Comparable<AccountSet.AccountSetFlag>,java.lang.constant.Constable
- Enclosing interface:
AccountSet
There are several options which can be either enabled or disabled for an account. Account options are represented
by different types of flags depending on the situation.
- The AccountSet transaction type has several "AccountSet Flags" (prefixed asf) that can enable an option when passed as the SetFlag parameter, or disable an option when passed as the ClearFlag parameter.
- The AccountSet transaction type has several transaction flags (prefixed tf) that can be used to enable or disable specific account options when passed in the Flags parameter. This style is discouraged. New account options do not have corresponding transaction (tf) flags.
- The AccountRoot ledger object type has several ledger-state-flags (prefixed lsf) which represent the state of particular account options within a particular ledger. These settings apply until a transaction changes them.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionTrack the ID of this account's most recent transaction.Enable clawback on the account's trustlines.Allow trust line tokens (IOUs) issued by this account to be held in escrow.Allow another account to mint and burn tokens on behalf of this account.Enable rippling on this account's trust lines by default.Enable Deposit Authorization on this account.Disallow use of the master key pair.Block incoming Checks.Block incoming NFTokenOffers.Block incoming Payment Channels.Block incoming Trustlines.XRP should not be sent to this account.Freeze all assets issued by this account.Permanently give up the ability to freeze individual trust lines or disable Global Freeze.This flag will do nothing but exists to accurately deserialize AccountSet transactions whoseSetFlagorClearFlagfields are zero.Require authorization for users to hold balances issued by this address.Require a destination tag to send transactions to this account. -
Method Summary
Modifier and TypeMethodDescriptionstatic AccountSet.AccountSetFlagforValue(int value) To deserialize enums with integer values, you need to specify this factory method with theJsonCreatorannotation, otherwise Jackson treats the JSON integer value as an ordinal.static Optional<AccountSet.AccountSetFlag> forValueIfValid(int value) Get theAccountSet.AccountSetFlagfor the given integer value, if one exists.intgetValue()Get the underlying value of thisAccountSet.AccountSetFlag.static AccountSet.AccountSetFlagReturns the enum constant of this type with the specified name.static AccountSet.AccountSetFlag[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
NONE
This flag will do nothing but exists to accurately deserialize AccountSet transactions whoseSetFlagorClearFlagfields are zero. -
REQUIRE_DEST
Require a destination tag to send transactions to this account. -
REQUIRE_AUTH
Require authorization for users to hold balances issued by this address. Can only be enabled if the address has no trust lines connected to it. -
DISALLOW_XRP
XRP should not be sent to this account. (Enforced by client applications, not by rippled). -
DISABLE_MASTER
Disallow use of the master key pair. Can only be enabled if the account has configured another way to sign transactions, such as a Regular Key or a Signer List. -
ACCOUNT_TXN_ID
Track the ID of this account's most recent transaction. Required forTransaction.accountTransactionId(). -
NO_FREEZE
Permanently give up the ability to freeze individual trust lines or disable Global Freeze. This flag can never be disabled after being enabled.- See Also:
-
GLOBAL_FREEZE
Freeze all assets issued by this account.- See Also:
-
DEFAULT_RIPPLE
Enable rippling on this account's trust lines by default.- See Also:
-
DEPOSIT_AUTH
Enable Deposit Authorization on this account.- See Also:
-
AUTHORIZED_MINTER
Allow another account to mint and burn tokens on behalf of this account. -
DISALLOW_INCOMING_NFT_OFFER
Block incoming NFTokenOffers. -
DISALLOW_INCOMING_CHECK
Block incoming Checks. -
DISALLOW_INCOMING_PAY_CHAN
Block incoming Payment Channels. -
DISALLOW_INCOMING_TRUSTLINE
Block incoming Trustlines. -
ALLOW_TRUSTLINE_CLAWBACK
Enable clawback on the account's trustlines.This value will be marked
Betauntil the Clawback amendment is enabled on mainnet. Its API is subject to change. -
ALLOW_TRUSTLINE_LOCKING
Allow trust line tokens (IOUs) issued by this account to be held in escrow. (Requires the TokenEscrow amendment.) Can only be enabled by the issuer account.This value will be marked
Betauntil the TokenEscrow amendment is enabled on mainnet. Its API is subject to change.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- if the argument is null
-
forValue
To deserialize enums with integer values, you need to specify this factory method with theJsonCreatorannotation, otherwise Jackson treats the JSON integer value as an ordinal.- Parameters:
value- The int value of the flag.- Returns:
- The
AccountSet.AccountSetFlagfor the given integer value. - Throws:
IllegalArgumentException- if no matchingAccountSet.AccountSetFlagexists for the given value.- See Also:
-
forValueIfValid
Get theAccountSet.AccountSetFlagfor the given integer value, if one exists.This method is useful when you need to check if a value corresponds to a known
AccountSet.AccountSetFlagwithout throwing an exception for unknown values (e.g., values reserved for future amendments like value 11 which is reserved for the Hooks amendment).- Parameters:
value- The int value of the flag.- Returns:
- An
Optionalcontaining theAccountSet.AccountSetFlagif one exists for the given value, orOptional.empty()if no matching flag exists.
-
getValue
public int getValue()Get the underlying value of thisAccountSet.AccountSetFlag.- Returns:
- The underlying
intvalue of thisAccountSet.AccountSetFlag.
-