Package org.eclipse.hono.util
Enum CredentialsConstants.CredentialsAction
- java.lang.Object
-
- java.lang.Enum<CredentialsConstants.CredentialsAction>
-
- org.eclipse.hono.util.CredentialsConstants.CredentialsAction
-
- All Implemented Interfaces:
Serializable
,Comparable<CredentialsConstants.CredentialsAction>
- Enclosing class:
- CredentialsConstants
public static enum CredentialsConstants.CredentialsAction extends Enum<CredentialsConstants.CredentialsAction>
Request actions that belong to the Credentials API.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description add
The AMQP subject property value to use for invoking the add Credentials operation.get
The AMQP subject property value to use for invoking the get Credentials operation.unknown
The name that all unknown operations are mapped to.update
The AMQP subject property value to use for invoking the update Credentials operation.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static CredentialsConstants.CredentialsAction
from(String subject)
Construct a CredentialsAction from a subject.static boolean
isValid(String subject)
Helper method to check if a subject is a valid Credentials API action.static CredentialsConstants.CredentialsAction
valueOf(String name)
Returns the enum constant of this type with the specified name.static CredentialsConstants.CredentialsAction[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
get
public static final CredentialsConstants.CredentialsAction get
The AMQP subject property value to use for invoking the get Credentials operation.
-
add
public static final CredentialsConstants.CredentialsAction add
The AMQP subject property value to use for invoking the add Credentials operation.
-
update
public static final CredentialsConstants.CredentialsAction update
The AMQP subject property value to use for invoking the update Credentials operation.
-
unknown
public static final CredentialsConstants.CredentialsAction unknown
The name that all unknown operations are mapped to.
-
-
Method Detail
-
values
public static CredentialsConstants.CredentialsAction[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (CredentialsConstants.CredentialsAction c : CredentialsConstants.CredentialsAction.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CredentialsConstants.CredentialsAction 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 nameNullPointerException
- if the argument is null
-
from
public static CredentialsConstants.CredentialsAction from(String subject)
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
public static boolean isValid(String subject)
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.
-
-