Package com.atlassian.plugin

Enum Class PluginRestartState

java.lang.Object

java.lang.Enum<PluginRestartState>

com.atlassian.plugin.PluginRestartState

All Implemented Interfaces:

Serializable, Comparable<PluginRestartState>, Constable

public enum PluginRestartState
extends Enum<PluginRestartState>

The state of the plugin after restart. This value indicates the action that will be performed for plugins that cannot be installed, upgraded, or removed at runtime due to the com.atlassian.plugin.descriptors.RequiresRestart annotation on a used module descriptor.

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
INSTALL	Indicates an installation will be performed
NONE	Indicates no change upon restart
REMOVE	Indicates the plugin will be removed
UPGRADE	Indicates an upgrade will be performed

Method Summary

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

INSTALL

public static final PluginRestartState INSTALL

Indicates an installation will be performed

UPGRADE

public static final PluginRestartState UPGRADE

Indicates an upgrade will be performed

REMOVE

public static final PluginRestartState REMOVE

Indicates the plugin will be removed

NONE

public static final PluginRestartState NONE

Indicates no change upon restart

Method Details

values

public static PluginRestartState[] 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 PluginRestartState 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