Package com.codingchili.core.context

Enum Class LauncherCommandResult

java.lang.Object

java.lang.Enum<LauncherCommandResult>

com.codingchili.core.context.LauncherCommandResult

All Implemented Interfaces:

CommandResult, Serializable, Comparable<LauncherCommandResult>, Constable

public enum LauncherCommandResult
extends Enum<LauncherCommandResult>
implements CommandResult

Results returned from an #Command when it is executed by a #CommandExecutor.

If the command fails and wants to display the error message (stacktrace) that generated the failure, then the future passed from the #CommandExecutor should be failed, with the exception.

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
CONTINUE	Indicates that the command has executed successfully and that the #Launcher should continue processing any deployment blocks.
SHUTDOWN	Indicates that the command has executed successfully and that the system should shut down.
STARTED	Indicates that the command has executed successfully and that the command is to handle deployment.

Method Summary

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

SHUTDOWN

public static final LauncherCommandResult SHUTDOWN

Indicates that the command has executed successfully and that the system should shut down.

CONTINUE

public static final LauncherCommandResult CONTINUE

Indicates that the command has executed successfully and that the #Launcher should continue processing any deployment blocks.

STARTED

public static final LauncherCommandResult STARTED

Indicates that the command has executed successfully and that the command is to handle deployment. The #Launcher should not process any deployment blocks.

Method Details

values

public static LauncherCommandResult[] 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 LauncherCommandResult 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

getName

public String getName()

Specified by:

getName in interface CommandResult

Returns:

the name of the result as a string.