Package dev.sympho.modular_commands.api.command

Enum Class Command.Scope

java.lang.Object

java.lang.Enum<Command.Scope>

dev.sympho.modular_commands.api.command.Command.Scope

All Implemented Interfaces:

Serializable, Comparable<Command.Scope>, Constable

Enclosing interface:

Command<H extends @NonNull Handlers>

public static enum Command.Scope
extends Enum<Command.Scope>

The scopes that a command may be defined in.

Since:

1.0

Version:

1.0

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
GLOBAL	A command that can be invoked in either guild channels or private channels.
GUILD	A command that can only be invoked in guild channels.

Method Summary

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

GLOBAL

public static final Command.Scope GLOBAL

A command that can be invoked in either guild channels or private channels.

GUILD

public static final Command.Scope GUILD

A command that can only be invoked in guild channels.

Method Details

values

public static Command.Scope[] 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 Command.Scope 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