com.codelanx.codelanxlib.command

Enum CommandStatus

java.lang.Object

java.lang.Enum<CommandStatus>

com.codelanx.codelanxlib.command.CommandStatus

All Implemented Interfaces:

Serializable, Comparable<CommandStatus>

public enum CommandStatus
extends Enum<CommandStatus>

Represents the status of an executed command, and is returned upon the completion of the command's execution

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_ARGS User supplied bad command arguments
CONSOLE_ONLY Command is intended to be run by the console only
FAILED The command did not execute correctly
NO_PERMISSION The user does not have the appropriate permissions to execute this
PLAYER_ONLY Command is intended to be run by players only
RCON_ONLY Command is intended to be run by remote consoles (rcon) only
SUCCESS The command executed successfully

Method Summary

Modifier and Type	Method and Description
void	handle(org.bukkit.command.CommandSender sender, Lang format, SubCommand<?> cmd) Handles output to a CommandSender upon the execution of a command
static CommandStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static CommandStatus[]	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

SUCCESS

public static final CommandStatus SUCCESS

The command executed successfully

FAILED

public static final CommandStatus FAILED

The command did not execute correctly

BAD_ARGS

public static final CommandStatus BAD_ARGS

User supplied bad command arguments

PLAYER_ONLY

public static final CommandStatus PLAYER_ONLY

Command is intended to be run by players only

CONSOLE_ONLY

public static final CommandStatus CONSOLE_ONLY

Command is intended to be run by the console only

RCON_ONLY

public static final CommandStatus RCON_ONLY

Command is intended to be run by remote consoles (rcon) only

NO_PERMISSION

public static final CommandStatus NO_PERMISSION

The user does not have the appropriate permissions to execute this

Method Detail

values

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

Returns:

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

valueOf

public static CommandStatus 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

handle

public void handle(org.bukkit.command.CommandSender sender,
                   Lang format,
                   SubCommand<?> cmd)

Handles output to a CommandSender upon the execution of a command

Parameters:

sender - The CommandSender object that executed the command

format - The Lang being used as a format string

cmd - The SubCommand that was executed

Since:

0.1.0