Package com.atlassian.plugin

Enum Class PluginState

java.lang.Object

java.lang.Enum<PluginState>

com.atlassian.plugin.PluginState

All Implemented Interfaces:

Serializable, Comparable<PluginState>, Constable

public enum PluginState
extends Enum<PluginState>

Represents the state of the plugin

Since:

2.2.0

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
DISABLED	The plugin has been disabled
DISABLING	The plugin is in the process of being disabled
ENABLED	The plugin has been enabled
ENABLING	The plugin is in the process of being enabled
INSTALLED	The plugin has been installed into the plugin system
PENDING	A marker value to indicate that a state change is pending.
UNINSTALLED	The plugin has been uninstalled and should be unavailable

Method Summary

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

The plugin has been installed into the plugin system

ENABLING

public static final PluginState ENABLING

The plugin is in the process of being enabled

ENABLED

public static final PluginState ENABLED

The plugin has been enabled

DISABLING

public static final PluginState DISABLING

The plugin is in the process of being disabled

Since:

2.8.0

DISABLED

public static final PluginState DISABLED

The plugin has been disabled

UNINSTALLED

public static final PluginState UNINSTALLED

The plugin has been uninstalled and should be unavailable

PENDING

public static final PluginState PENDING

A marker value to indicate that a state change is pending. This is not an actual plugin state, and is not returned by Plugin.getPluginState(). It is used by helper functions returning PluginState to report special cases.

Since:

3.0.21

Method Details

values

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