Package cloud.commandframework

Enum CommandManager.RegistrationState

java.lang.Object

java.lang.Enum<CommandManager.RegistrationState>

cloud.commandframework.CommandManager.RegistrationState

All Implemented Interfaces:

Serializable, Comparable<CommandManager.RegistrationState>

Enclosing class:

CommandManager<C>

@API(status=STABLE,
     since="1.2.0")
public static enum CommandManager.RegistrationState
extends Enum<CommandManager.RegistrationState>

The point in the registration lifecycle for this commands manager

Since:

1.2.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
AFTER_REGISTRATION	Once registration has been completed.
BEFORE_REGISTRATION	The point when no commands have been registered yet.
REGISTERING	When at least one command has been registered, and more commands have been registered.

Method Summary

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

BEFORE_REGISTRATION

public static final CommandManager.RegistrationState BEFORE_REGISTRATION

The point when no commands have been registered yet.

At this point, all configuration options can be changed.

REGISTERING

public static final CommandManager.RegistrationState REGISTERING

When at least one command has been registered, and more commands have been registered.

In this state, some options that affect how commands are registered with the platform are frozen. Some platforms will remain in this state for their lifetime.

AFTER_REGISTRATION

public static final CommandManager.RegistrationState AFTER_REGISTRATION

Once registration has been completed.

At this point, the command manager is effectively immutable. On platforms where command registration happens via callback, this state is achieved the first time the manager's callback is executed for registration.

Method Details

values

public static CommandManager.RegistrationState[] values()

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

Returns:

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

valueOf

public static CommandManager.RegistrationState 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