net.mountainblade.modular

Enum ModuleState

java.lang.Object

java.lang.Enum<ModuleState>

net.mountainblade.modular.ModuleState

All Implemented Interfaces:

Serializable, Comparable<ModuleState>

public enum ModuleState
extends Enum<ModuleState>

Represents the state a module can be currently in.

Version:

1.0

Author:

spaceemotion

Enum Constant Summary

Enum Constants

Enum Constant and Description
LOADING The module has been recognized and is currently loading
READY The module is ready, the fields injected and its initialize method called (if there is one)
SHUTDOWN The module was running at least once and its shutdown method has been called (if there is one)
UNKNOWN The state is currently unknown, can happen when a module has just been recognized by the system

Method Summary

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

LOADING

public static final ModuleState LOADING

The module has been recognized and is currently loading

READY

public static final ModuleState READY

The module is ready, the fields injected and its initialize method called (if there is one)

SHUTDOWN

public static final ModuleState SHUTDOWN

The module was running at least once and its shutdown method has been called (if there is one)

UNKNOWN

public static final ModuleState UNKNOWN

The state is currently unknown, can happen when a module has just been recognized by the system

Method Detail

values

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

Returns:

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

valueOf

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