Package studio.mevera.imperat.command.tree

Enum Class CommandPathSearch.Result

java.lang.Object

java.lang.Enum<CommandPathSearch.Result>

studio.mevera.imperat.command.tree.CommandPathSearch.Result

All Implemented Interfaces:

Serializable, Comparable<CommandPathSearch.Result>, Constable

Enclosing class:

CommandPathSearch<S extends Source>

public static enum CommandPathSearch.Result
extends Enum<CommandPathSearch.Result>

Defines a setResult from dispatching the command execution.

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
COMPLETE	Defines a complete dispatch of the command, CommandUsage cannot be null unless the StandardCommandTree has issues
FAILURE	Defines an execution that ended up with throwing an exception that had no handler
PAUSE	The tree stopped midway for some reason, most probably would be that the source doesn't have access to a ParameterNode that matches his corresponding input.
UNKNOWN	Defines an unknown execution/command, it's the default setResult

Method Summary

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

PAUSE

public static final CommandPathSearch.Result PAUSE

The tree stopped midway for some reason, most probably would be that the source doesn't have access to a ParameterNode that matches his corresponding input.

COMPLETE

public static final CommandPathSearch.Result COMPLETE

Defines a complete dispatch of the command, CommandUsage cannot be null unless the StandardCommandTree has issues

UNKNOWN

public static final CommandPathSearch.Result UNKNOWN

Defines an unknown execution/command, it's the default setResult

FAILURE

public static final CommandPathSearch.Result FAILURE

Defines an execution that ended up with throwing an exception that had no handler

Method Details

values

public static CommandPathSearch.Result[] 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 CommandPathSearch.Result 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

isStoppable

public boolean isStoppable()