org.jivesoftware.smackx.commands

Enum AdHocCommand.Action

java.lang.Object

java.lang.Enum<AdHocCommand.Action>

org.jivesoftware.smackx.commands.AdHocCommand.Action

All Implemented Interfaces:

Serializable, Comparable<AdHocCommand.Action>

Enclosing class:

AdHocCommand

public static enum AdHocCommand.Action
extends Enum<AdHocCommand.Action>

Enum Constant Summary

Enum Constants

Enum Constant and Description
cancel The command should be canceled.
complete The command should be completed (if possible).
execute The command should be executed or continue to be executed.
next The command should progress to the next stage of execution.
prev The command should be digress to the previous stage of execution.
unknown The action is unknow.

Method Summary

Modifier and Type	Method and Description
static AdHocCommand.Action	valueOf(String name) Returns the enum constant of this type with the specified name.
static AdHocCommand.Action[]	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

execute

public static final AdHocCommand.Action execute

The command should be executed or continue to be executed. This is the default value.

cancel

public static final AdHocCommand.Action cancel

The command should be canceled.

prev

public static final AdHocCommand.Action prev

The command should be digress to the previous stage of execution.

next

public static final AdHocCommand.Action next

The command should progress to the next stage of execution.

complete

public static final AdHocCommand.Action complete

The command should be completed (if possible).

unknown

public static final AdHocCommand.Action unknown

The action is unknow. This is used when a recieved message has an unknown action. It must not be used to send an execution request.

Method Detail

values

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

Returns:

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

valueOf

public static AdHocCommand.Action 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 name

NullPointerException - if the argument is null