Enum GranularPermission
- All Implemented Interfaces:
Serializable,Comparable<GranularPermission>,java.lang.constant.Constable
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionPermission to modify the domain of an account.Permission to modify the EmailHash of an account.Permission to modify the MessageKey of an account.Permission to modify the TickSize of an account.Permission to modify the TransferRate of an account.Permission to lock an MPToken issuance.Permission to unlock an MPToken issuance.Permission to burn tokens via Payment transaction.Permission to mint tokens via Payment transaction.Permission to authorize a trustline.Permission to freeze a trustline.Permission to unfreeze a trustline. -
Method Summary
Modifier and TypeMethodDescriptionstatic Optional<GranularPermission> Gets an instance ofGranularPermissionfor the given string value.intGet the numeric value of thisGranularPermission.value()Get the underlying string value of thisGranularPermission.static GranularPermissionReturns the enum constant of this type with the specified name.static GranularPermission[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
TRUSTLINE_AUTHORIZE
Permission to authorize a trustline. -
TRUSTLINE_FREEZE
Permission to freeze a trustline. -
TRUSTLINE_UNFREEZE
Permission to unfreeze a trustline. -
ACCOUNT_DOMAIN_SET
Permission to modify the domain of an account. -
ACCOUNT_EMAIL_HASH_SET
Permission to modify the EmailHash of an account. -
ACCOUNT_MESSAGE_KEY_SET
Permission to modify the MessageKey of an account. -
ACCOUNT_TRANSFER_RATE_SET
Permission to modify the TransferRate of an account. -
ACCOUNT_TICK_SIZE_SET
Permission to modify the TickSize of an account. -
PAYMENT_MINT
Permission to mint tokens via Payment transaction. -
PAYMENT_BURN
Permission to burn tokens via Payment transaction. -
MPTOKEN_ISSUANCE_LOCK
Permission to lock an MPToken issuance. -
MPTOKEN_ISSUANCE_UNLOCK
Permission to unlock an MPToken issuance.
-
-
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
Gets an instance ofGranularPermissionfor the given string value.- Parameters:
value- TheStringvalue corresponding to aGranularPermission.- Returns:
- An
Optionalcontaining theGranularPermissionwith the corresponding value, orOptional.empty()if not found.
-
value
Get the underlying string value of thisGranularPermission.- Returns:
- The
Stringvalue.
-
numericValue
public int numericValue()Get the numeric value of thisGranularPermission.- Returns:
- The numeric value as an int.
-