Package org.eclipse.hono.util
Enum Class CredentialsConstants.CredentialsAction
java.lang.Object
java.lang.Enum<CredentialsConstants.CredentialsAction>
org.eclipse.hono.util.CredentialsConstants.CredentialsAction
- All Implemented Interfaces:
Serializable
,Comparable<CredentialsConstants.CredentialsAction>
,Constable
- Enclosing class:
- CredentialsConstants
public static enum CredentialsConstants.CredentialsAction
extends Enum<CredentialsConstants.CredentialsAction>
Request actions that belong to the Credentials API.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionThe AMQP subject property value to use for invoking the add Credentials operation.The AMQP subject property value to use for invoking the get Credentials operation.The name that all unknown operations are mapped to.The AMQP subject property value to use for invoking the update Credentials operation. -
Method Summary
Modifier and TypeMethodDescriptionConstruct a CredentialsAction from a subject.static boolean
Helper method to check if a subject is a valid Credentials API action.Returns the enum constant of this class with the specified name.values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
get
The AMQP subject property value to use for invoking the get Credentials operation. -
add
The AMQP subject property value to use for invoking the add Credentials operation. -
update
The AMQP subject property value to use for invoking the update Credentials operation. -
unknown
The name that all unknown operations are mapped to.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
from
Construct a CredentialsAction from a subject.- Parameters:
subject
- The subject from which the CredentialsAction needs to be constructed.- Returns:
- CredentialsAction The CredentialsAction as enum, or
unknown
otherwise.
-
isValid
Helper method to check if a subject is a valid Credentials API action.- Parameters:
subject
- The subject to validate.- Returns:
- boolean
Boolean.TRUE
if the subject denotes a valid action,Boolean.FALSE
otherwise.
-