Package com.velocitypowered.api.command

Enum Class CommandResult

java.lang.Object

java.lang.Enum<CommandResult>

com.velocitypowered.api.command.CommandResult

All Implemented Interfaces:

Serializable, Comparable<CommandResult>, Constable

public enum CommandResult
extends Enum<CommandResult>

The result of a command invocation attempt.

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
EXCEPTION	An unexpected exception occurred while executing the command in the proxy.
EXECUTED	The command was successfully executed by the proxy.
FORWARDED	The command was forwarded to the backend server.
SYNTAX_ERROR	The provided command input contained syntax errors.

Method Summary

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

EXECUTED

public static final CommandResult EXECUTED

The command was successfully executed by the proxy.

FORWARDED

public static final CommandResult FORWARDED

The command was forwarded to the backend server. The command may be successfully executed or not

SYNTAX_ERROR

public static final CommandResult SYNTAX_ERROR

The provided command input contained syntax errors.

EXCEPTION

public static final CommandResult EXCEPTION

An unexpected exception occurred while executing the command in the proxy.

Method Details

values

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