Class AccountRootFlags

java.lang.Object
org.xrpl.xrpl4j.model.flags.Flags
org.xrpl.xrpl4j.model.flags.AccountRootFlags

public class AccountRootFlags extends Flags
A set of static Flags which can be set on AccountSet transactions.
  • Field Details

    • UNSET

      public static final AccountRootFlags UNSET
      Constant for an unset flag.
    • DEFAULT_RIPPLE

      public static final AccountRootFlags DEFAULT_RIPPLE
      Constant AccountRootFlags for the lsfDefaultRipple account flag.
    • DEPOSIT_AUTH

      public static final AccountRootFlags DEPOSIT_AUTH
      Constant AccountRootFlags for the lsfDepositAuth account flag.
    • DISABLE_MASTER

      public static final AccountRootFlags DISABLE_MASTER
      Constant AccountRootFlags for the lsfDisableMaster account flag.
    • DISALLOW_XRP

      public static final AccountRootFlags DISALLOW_XRP
      Constant AccountRootFlags for the lsfDisallowXRP account flag.
    • GLOBAL_FREEZE

      public static final AccountRootFlags GLOBAL_FREEZE
      Constant AccountRootFlags for the lsfGlobalFreeze account flag.
    • NO_FREEZE

      public static final AccountRootFlags NO_FREEZE
      Constant AccountRootFlags for the lsfNoFreeze account flag.
    • PASSWORD_SPENT

      public static final AccountRootFlags PASSWORD_SPENT
      Constant AccountRootFlags for the lsfPasswordSpent account flag.
    • REQUIRE_AUTH

      public static final AccountRootFlags REQUIRE_AUTH
      Constant AccountRootFlags for the lsfRequireAuth account flag.
    • REQUIRE_DEST_TAG

      public static final AccountRootFlags REQUIRE_DEST_TAG
      Constant AccountRootFlags for the lsfRequireDestTag account flag.
    • DISALLOW_INCOMING_NFT_OFFER

      public static final AccountRootFlags DISALLOW_INCOMING_NFT_OFFER
      Constant AccountRootFlags for the lsfDisallowIncomingNFTokenOffer account flag.
    • DISALLOW_INCOMING_CHECK

      public static final AccountRootFlags DISALLOW_INCOMING_CHECK
      Constant AccountRootFlags for the lsfDisallowIncomingCheck account flag.
    • DISALLOW_INCOMING_PAY_CHAN

      public static final AccountRootFlags DISALLOW_INCOMING_PAY_CHAN
      Constant AccountRootFlags for the lsfDisallowIncomingPayChan account flag.
    • DISALLOW_INCOMING_TRUSTLINE

      public static final AccountRootFlags DISALLOW_INCOMING_TRUSTLINE
      Constant AccountRootFlags for the lsfDisallowIncomingTrustline account flag.
    • ALLOW_TRUSTLINE_CLAWBACK

      @Beta public static final AccountRootFlags ALLOW_TRUSTLINE_CLAWBACK
      Constant AccountRootFlags for the lsfAllowTrustLineClawback account flag.

      This constant 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 AccountRootFlags ALLOW_TRUSTLINE_LOCKING
      Constant AccountRootFlags for the lsfAllowTrustLineLocking account flag.

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

  • Method Details

    • of

      public static AccountRootFlags of(long value)
      Construct AccountRootFlags with a given value.
      Parameters:
      value - The long-number encoded flags value of this AccountRootFlags.
      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:
      true if lsfDefaultRipple is set, otherwise false.
    • lsfDepositAuth

      public boolean lsfDepositAuth()
      This account can only receive funds from transactions it sends, and from preauthorized accounts. (It has DepositAuth enabled.)
      Returns:
      true if lsfDepositAuth is set, otherwise false.
    • lsfDisableMaster

      public boolean lsfDisableMaster()
      Disallows use of the master key to sign transactions for this account.
      Returns:
      true if lsfDisableMaster is set, otherwise false.
    • lsfDisallowXrp

      public boolean lsfDisallowXrp()
      Client applications should not send XRP to this account. Not enforced by rippled.
      Returns:
      true if lsfDisallowXrp is set, otherwise false.
    • lsfGlobalFreeze

      public boolean lsfGlobalFreeze()
      All assets issued by this address are frozen.
      Returns:
      true if lsfGlobalFreeze is set, otherwise false.
    • lsfNoFreeze

      public boolean lsfNoFreeze()
      This address cannot freeze trust lines connected to it. Once enabled, cannot be disabled.
      Returns:
      true if lsfNoFreeze is set, otherwise false.
    • lsfPasswordSpent

      public boolean lsfPasswordSpent()
      The account has used its free SetRegularKey transaction.
      Returns:
      true if lsfPasswordSpent is set, otherwise false.
    • lsfRequireAuth

      public boolean lsfRequireAuth()
      This account must individually approve other users for those users to hold this account's issued currencies.
      Returns:
      true if lsfRequireAuth is set, otherwise false.
    • lsfRequireDestTag

      public boolean lsfRequireDestTag()
      Requires incoming payments to specify a Destination Tag.
      Returns:
      true if lsfRequireDestTag is set, otherwise false.
    • lsfDisallowIncomingNFTokenOffer

      public boolean lsfDisallowIncomingNFTokenOffer()
      Blocks incoming NFToken Offers.
      Returns:
      true if lsfDisallowIncomingNFTokenOffer is set, otherwise false.
    • lsfDisallowIncomingCheck

      public boolean lsfDisallowIncomingCheck()
      Blocks incoming Checks.
      Returns:
      true if lsfDisallowIncomingCheck is set, otherwise false.
    • lsfDisallowIncomingPayChan

      public boolean lsfDisallowIncomingPayChan()
      Blocks incoming Payment Channels.
      Returns:
      true if lsfDisallowIncomingPayChan is set, otherwise false.
    • lsfDisallowIncomingTrustline

      public boolean lsfDisallowIncomingTrustline()
      Blocks incoming Trustlines.
      Returns:
      true if lsfDisallowIncomingTrustline is set, otherwise false.
    • lsfAllowTrustLineClawback

      @Beta public boolean lsfAllowTrustLineClawback()
      Allows trustline clawback on this account.

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

      Returns:
      true if lsfAllowTrustLineClawback is set, otherwise false.
    • lsfAllowTrustLineLocking

      @Beta public boolean lsfAllowTrustLineLocking()
      Allows trust line tokens (IOUs) issued by this account to be held in escrow.

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

      Returns:
      true if lsfAllowTrustLineLocking is set, otherwise false.