com.sitewhere.spi.command

Enum CommandResult

java.lang.Object

java.lang.Enum<CommandResult>

com.sitewhere.spi.command.CommandResult

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CommandResult>

public enum CommandResult
extends java.lang.Enum<CommandResult>

Indicates the result status for a command.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Failed Command failed
Successful Command was successful

Method Summary

Modifier and Type	Method and Description
static CommandResult	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CommandResult[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Successful

public static final CommandResult Successful

Command was successful

Failed

public static final CommandResult Failed

Command failed

Method Detail

values

public static CommandResult[] 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 (CommandResult c : CommandResult.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CommandResult valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null