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

public static enum AccountSet.AccountSetFlag extends Enum<AccountSet.AccountSetFlag>
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.
  • Enum Constant Details

    • NONE

      public static final AccountSet.AccountSetFlag NONE
      This flag will do nothing but exists to accurately deserialize AccountSet transactions whose SetFlag or ClearFlag fields are zero.
    • REQUIRE_DEST

      public static final AccountSet.AccountSetFlag REQUIRE_DEST
      Require a destination tag to send transactions to this account.
    • REQUIRE_AUTH

      public static final AccountSet.AccountSetFlag 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

      public static final AccountSet.AccountSetFlag DISALLOW_XRP
      XRP should not be sent to this account. (Enforced by client applications, not by rippled).
    • DISABLE_MASTER

      public static final AccountSet.AccountSetFlag 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

      public static final AccountSet.AccountSetFlag ACCOUNT_TXN_ID
      Track the ID of this account's most recent transaction. Required for Transaction.accountTransactionId().
    • NO_FREEZE

      public static final AccountSet.AccountSetFlag 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:
      • "https://xrpl.org/freezes.html"
    • GLOBAL_FREEZE

      public static final AccountSet.AccountSetFlag GLOBAL_FREEZE
      Freeze all assets issued by this account.
      See Also:
      • "https://xrpl.org/freezes.html"
    • DEFAULT_RIPPLE

      public static final AccountSet.AccountSetFlag DEFAULT_RIPPLE
      Enable rippling on this account's trust lines by default.
      See Also:
      • "https://xrpl.org/rippling.html"
    • DEPOSIT_AUTH

      public static final AccountSet.AccountSetFlag DEPOSIT_AUTH
      Enable Deposit Authorization on this account.
      See Also:
      • "https://xrpl.org/depositauth.html"
    • AUTHORIZED_MINTER

      public static final AccountSet.AccountSetFlag AUTHORIZED_MINTER
      Allow another account to mint and burn tokens on behalf of this account.
    • DISALLOW_INCOMING_NFT_OFFER

      public static final AccountSet.AccountSetFlag DISALLOW_INCOMING_NFT_OFFER
      Block incoming NFTokenOffers.
    • DISALLOW_INCOMING_CHECK

      public static final AccountSet.AccountSetFlag DISALLOW_INCOMING_CHECK
      Block incoming Checks.
    • DISALLOW_INCOMING_PAY_CHAN

      public static final AccountSet.AccountSetFlag DISALLOW_INCOMING_PAY_CHAN
      Block incoming Payment Channels.
    • DISALLOW_INCOMING_TRUSTLINE

      public static final AccountSet.AccountSetFlag DISALLOW_INCOMING_TRUSTLINE
      Block incoming Trustlines.
    • ALLOW_TRUSTLINE_CLAWBACK

      @Beta public static final AccountSet.AccountSetFlag ALLOW_TRUSTLINE_CLAWBACK
      Enable clawback on the account's trustlines.

      This value will be marked Beta until the Clawback amendment is enabled on mainnet. Its API is subject to change.

    • ALLOW_TRUSTLINE_LOCKING

      @Beta public static final AccountSet.AccountSetFlag 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 Beta until the TokenEscrow amendment is enabled on mainnet. Its API is subject to change.

  • Method Details

    • values

      public static AccountSet.AccountSetFlag[] 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

      public static AccountSet.AccountSetFlag valueOf(String name)
      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 name
      NullPointerException - if the argument is null
    • forValue

      public static AccountSet.AccountSetFlag forValue(int value)
      To deserialize enums with integer values, you need to specify this factory method with the JsonCreator annotation, otherwise Jackson treats the JSON integer value as an ordinal.
      Parameters:
      value - The int value of the flag.
      Returns:
      The AccountSet.AccountSetFlag for the given integer value.
      Throws:
      IllegalArgumentException - if no matching AccountSet.AccountSetFlag exists for the given value.
      See Also:
      • "https://github.com/FasterXML/jackson-databind/issues/1850"
    • forValueIfValid

      public static Optional<AccountSet.AccountSetFlag> forValueIfValid(int value)
      Get the AccountSet.AccountSetFlag for the given integer value, if one exists.

      This method is useful when you need to check if a value corresponds to a known AccountSet.AccountSetFlag without 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 Optional containing the AccountSet.AccountSetFlag if one exists for the given value, or Optional.empty() if no matching flag exists.
    • getValue

      public int getValue()
      Get the underlying value of this AccountSet.AccountSetFlag.
      Returns:
      The underlying int value of this AccountSet.AccountSetFlag.