Package eu.rarogsoftware.rarog.platform.api.plugins

Enum Class Plugin.PluginState

java.lang.Object

java.lang.Enum<Plugin.PluginState>

eu.rarogsoftware.rarog.platform.api.plugins.Plugin.PluginState

All Implemented Interfaces:

Serializable, Comparable<Plugin.PluginState>, Constable

Enclosing interface:

Plugin

public static enum Plugin.PluginState
extends Enum<Plugin.PluginState>

Represents internal state of plugin in system

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
ACTIVE	Plugin is enabled and serving functionality for users.
DISABLING	Plugin is going down and is no longer serving any functionality.
ENABLED	Plugin is serving functionality to other plugins, but it is not serving any functionality for users.
ENABLING	Plugin is preparing to be serving functionality to other plugins.
INSTALLED	Plugin is installed in system and is ready to be enabled.
UNINSTALLED	Plugin is awaiting removal from system and cannot be enabled.

Method Summary

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

INSTALLED

public static final Plugin.PluginState INSTALLED

Plugin is installed in system and is ready to be enabled.

ENABLING

public static final Plugin.PluginState ENABLING

Plugin is preparing to be serving functionality to other plugins.

ENABLED

public static final Plugin.PluginState ENABLED

Plugin is serving functionality to other plugins, but it is not serving any functionality for users.

ACTIVE

public static final Plugin.PluginState ACTIVE

Plugin is enabled and serving functionality for users.

DISABLING

public static final Plugin.PluginState DISABLING

Plugin is going down and is no longer serving any functionality.

UNINSTALLED

public static final Plugin.PluginState UNINSTALLED

Plugin is awaiting removal from system and cannot be enabled.

Method Details

values

public static Plugin.PluginState[] 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 Plugin.PluginState 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