Package com.avrix.enums

Enum Class CommandScope

java.lang.Object

java.lang.Enum<CommandScope>

com.avrix.enums.CommandScope

All Implemented Interfaces:

Serializable, Comparable<CommandScope>, Constable

public enum CommandScope
extends Enum<CommandScope>

Enumerates the scopes where a command can be executed.

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
BOTH	Indicates that the command is available for execution in both chat and console.
CHAT	Indicates that the command is available for execution only in the chat.
CONSOLE	Indicates that the command is available for execution only in the console.

Method Summary

Modifier and Type	Method	Description
static CommandScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CommandScope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CHAT

public static final CommandScope CHAT

Indicates that the command is available for execution only in the chat.

CONSOLE

public static final CommandScope CONSOLE

Indicates that the command is available for execution only in the console.

BOTH

public static final CommandScope BOTH

Indicates that the command is available for execution in both chat and console.

Method Details

values

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