com.qcadoo.plugin.api

Enum PluginState

java.lang.Object

java.lang.Enum<PluginState>

com.qcadoo.plugin.api.PluginState

All Implemented Interfaces:

Serializable, Comparable<PluginState>

public enum PluginState
extends Enum<PluginState>

State of the plugin.

Since:

0.4.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISABLED Inactive in the system, can be activated without restart.
ENABLED Active in the system.
ENABLING Inactive in the system, will be activated after restart.
TEMPORARY Inactive in the system, cannot be activated without restart.
UNKNOWN Transitional state, after system restart before database synchronization.

Method Summary

Modifier and Type	Method and Description
static PluginState	valueOf(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

compareTo, equals, 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 PluginState DISABLED

Inactive in the system, can be activated without restart.

ENABLED

public static final PluginState ENABLED

Active in the system.

ENABLING

public static final PluginState ENABLING

Inactive in the system, will be activated after restart.

TEMPORARY

public static final PluginState TEMPORARY

Inactive in the system, cannot be activated without restart.

UNKNOWN

public static final PluginState UNKNOWN

Transitional state, after system restart before database synchronization. This status cannot exists in initialized application.

Method Detail

valueOf

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

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