Module interacto.java.api

Package io.github.interacto.command

Enum Command.CmdStatus

java.lang.Object

java.lang.Enum<Command.CmdStatus>

io.github.interacto.command.Command.CmdStatus

All Implemented Interfaces:

Serializable, Comparable<Command.CmdStatus>

Enclosing interface:

Command

public static enum Command.CmdStatus
extends Enum<Command.CmdStatus>

Defines the different states of the command.

Since:

0.2

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED	When the command has been cancelled.
CREATED	When the command is created but not executed yet.
DONE	When the command has been marked as done.
EXECUTED	When the command has been created and executed one time.
FLUSHED	The command has been flushed.

Method Summary

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

CREATED

public static final Command.CmdStatus CREATED

When the command is created but not executed yet.

EXECUTED

public static final Command.CmdStatus EXECUTED

When the command has been created and executed one time.

CANCELLED

public static final Command.CmdStatus CANCELLED

When the command has been cancelled.

DONE

public static final Command.CmdStatus DONE

When the command has been marked as done.

FLUSHED

public static final Command.CmdStatus FLUSHED

The command has been flushed. In this case, the cmd must not be used anymore.

Method Detail

values

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

Returns:

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

valueOf

public static Command.CmdStatus 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