com.github.unafraid.plugins

Enum PluginState

java.lang.Object

java.lang.Enum<PluginState>

com.github.unafraid.plugins.PluginState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PluginState>

public enum PluginState
extends java.lang.Enum<PluginState>

A simple enum that contains the possible plugin states this API/you might set.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVAILABLE The initial state of a newly scanned plugin.
INITIALIZED Initialized state of the plugin, at this state you can assume it is loaded, but not yet installed or started.
INSTALLED The state when the plugin is being installed by the user.
STARTED Self-explanatory name: When the plugin is running.

Method Summary

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

AVAILABLE

public static final PluginState AVAILABLE

The initial state of a newly scanned plugin.

INITIALIZED

public static final PluginState INITIALIZED

Initialized state of the plugin, at this state you can assume it is loaded, but not yet installed or started.

INSTALLED

public static final PluginState INSTALLED

The state when the plugin is being installed by the user.

STARTED

public static final PluginState STARTED

Self-explanatory name: When the plugin is running.

Method Detail

values

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

Returns:

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

valueOf

public static PluginState valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null