Package org.eclipse.hono.util

Enum Class CommandRouterConstants.CommandRouterAction

java.lang.Object

java.lang.Enum<CommandRouterConstants.CommandRouterAction>

org.eclipse.hono.util.CommandRouterConstants.CommandRouterAction

All Implemented Interfaces:

Serializable, Comparable<CommandRouterConstants.CommandRouterAction>, Constable

Enclosing class:

CommandRouterConstants

public static enum CommandRouterConstants.CommandRouterAction
extends Enum<CommandRouterConstants.CommandRouterAction>

Request actions that belong to the Command Router API.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ENABLE_COMMAND_ROUTING	The enable command routing operation.
REGISTER_COMMAND_CONSUMER	The register command consumer operation.
SET_LAST_KNOWN_GATEWAY	The set last known gateway for device operation.
UNKNOWN	The unknown operation.
UNREGISTER_COMMAND_CONSUMER	The unregister command consumer operation.

Method Summary

Modifier and Type	Method	Description
static CommandRouterConstants.CommandRouterAction	from(String subject)	Construct a CommandRouterAction from a subject.
String	getSubject()	Gets the AMQP message subject corresponding to this action.
static boolean	isValid(String subject)	Helper method to check if a subject is a valid Command Router API action.
static CommandRouterConstants.CommandRouterAction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CommandRouterConstants.CommandRouterAction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SET_LAST_KNOWN_GATEWAY

public static final CommandRouterConstants.CommandRouterAction SET_LAST_KNOWN_GATEWAY

The set last known gateway for device operation.

REGISTER_COMMAND_CONSUMER

public static final CommandRouterConstants.CommandRouterAction REGISTER_COMMAND_CONSUMER

The register command consumer operation.

UNREGISTER_COMMAND_CONSUMER

public static final CommandRouterConstants.CommandRouterAction UNREGISTER_COMMAND_CONSUMER

The unregister command consumer operation.

ENABLE_COMMAND_ROUTING

public static final CommandRouterConstants.CommandRouterAction ENABLE_COMMAND_ROUTING

The enable command routing operation.

UNKNOWN

public static final CommandRouterConstants.CommandRouterAction UNKNOWN

The unknown operation.

Method Details

values

public static CommandRouterConstants.CommandRouterAction[] 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

public static CommandRouterConstants.CommandRouterAction valueOf(String name)

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 name

NullPointerException - if the argument is null

getSubject

public String getSubject()

Gets the AMQP message subject corresponding to this action.

Returns:

The subject.

from

public static CommandRouterConstants.CommandRouterAction from(String subject)

Construct a CommandRouterAction from a subject.

Parameters:

subject - The subject from which the CommandRouterAction needs to be constructed.

Returns:

The CommandRouterAction as enum.

isValid

public static boolean isValid(String subject)

Helper method to check if a subject is a valid Command Router API action.

Parameters:

subject - The subject to validate.

Returns:

boolean Boolean.TRUE if the subject denotes a valid action, Boolean.FALSE otherwise.