Enum GranularPermission

java.lang.Object
java.lang.Enum<GranularPermission>
org.xrpl.xrpl4j.model.transactions.GranularPermission
All Implemented Interfaces:
Serializable, Comparable<GranularPermission>, java.lang.constant.Constable

@Beta public enum GranularPermission extends Enum<GranularPermission>
Enumeration of granular permission types for delegated credentials. These permissions support control over specific portions of transactions, rather than entire transaction types.

Granular permission values are always greater than 65536 (UINT16_MAX) to avoid conflicts with transaction type permission values.

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

  • Enum Constant Details

    • TRUSTLINE_AUTHORIZE

      public static final GranularPermission TRUSTLINE_AUTHORIZE
      Permission to authorize a trustline.
    • TRUSTLINE_FREEZE

      public static final GranularPermission TRUSTLINE_FREEZE
      Permission to freeze a trustline.
    • TRUSTLINE_UNFREEZE

      public static final GranularPermission TRUSTLINE_UNFREEZE
      Permission to unfreeze a trustline.
    • ACCOUNT_DOMAIN_SET

      public static final GranularPermission ACCOUNT_DOMAIN_SET
      Permission to modify the domain of an account.
    • ACCOUNT_EMAIL_HASH_SET

      public static final GranularPermission ACCOUNT_EMAIL_HASH_SET
      Permission to modify the EmailHash of an account.
    • ACCOUNT_MESSAGE_KEY_SET

      public static final GranularPermission ACCOUNT_MESSAGE_KEY_SET
      Permission to modify the MessageKey of an account.
    • ACCOUNT_TRANSFER_RATE_SET

      public static final GranularPermission ACCOUNT_TRANSFER_RATE_SET
      Permission to modify the TransferRate of an account.
    • ACCOUNT_TICK_SIZE_SET

      public static final GranularPermission ACCOUNT_TICK_SIZE_SET
      Permission to modify the TickSize of an account.
    • PAYMENT_MINT

      public static final GranularPermission PAYMENT_MINT
      Permission to mint tokens via Payment transaction.
    • PAYMENT_BURN

      public static final GranularPermission PAYMENT_BURN
      Permission to burn tokens via Payment transaction.
    • MPTOKEN_ISSUANCE_LOCK

      public static final GranularPermission MPTOKEN_ISSUANCE_LOCK
      Permission to lock an MPToken issuance.
    • MPTOKEN_ISSUANCE_UNLOCK

      public static final GranularPermission MPTOKEN_ISSUANCE_UNLOCK
      Permission to unlock an MPToken issuance.
  • Method Details

    • values

      public static GranularPermission[] 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 GranularPermission 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 Optional<GranularPermission> forValue(String value)
      Gets an instance of GranularPermission for the given string value.
      Parameters:
      value - The String value corresponding to a GranularPermission.
      Returns:
      An Optional containing the GranularPermission with the corresponding value, or Optional.empty() if not found.
    • value

      public String value()
      Get the underlying string value of this GranularPermission.
      Returns:
      The String value.
    • numericValue

      public int numericValue()
      Get the numeric value of this GranularPermission.
      Returns:
      The numeric value as an int.