io.github.nucleuspowered.nucleus.api.events

Enum NucleusModuleEvent.ModuleEnableState

java.lang.Object

java.lang.Enum<NucleusModuleEvent.ModuleEnableState>

io.github.nucleuspowered.nucleus.api.events.NucleusModuleEvent.ModuleEnableState

All Implemented Interfaces:

Serializable, Comparable<NucleusModuleEvent.ModuleEnableState>

Enclosing interface:

NucleusModuleEvent

public static enum NucleusModuleEvent.ModuleEnableState
extends Enum<NucleusModuleEvent.ModuleEnableState>

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED Indicates that the module has been disabled and will not be/has not been loaded.
ENABLED Indicates that the module is currently enabled and will be, or has been, loaded.
FORCE_ENABLED Indicates that the module is currently enabled and cannot be disabled.

Method Summary

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

DISABLED

public static final NucleusModuleEvent.ModuleEnableState DISABLED

Indicates that the module has been disabled and will not be/has not been loaded.

ENABLED

public static final NucleusModuleEvent.ModuleEnableState ENABLED

Indicates that the module is currently enabled and will be, or has been, loaded.

Modules in this state can be disabled any time before NucleusModuleEvent.AboutToEnable completes, using NucleusModuleEvent.AboutToConstruct.disableModule(String, Object).

FORCE_ENABLED

public static final NucleusModuleEvent.ModuleEnableState FORCE_ENABLED

Indicates that the module is currently enabled and cannot be disabled. It will be, or has been, loaded.

Method Detail

values

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

Returns:

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

valueOf

public static NucleusModuleEvent.ModuleEnableState 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