com.atlassian.plugin

Enum PluginRestartState

java.lang.Object

java.lang.Enum<PluginRestartState>

com.atlassian.plugin.PluginRestartState

All Implemented Interfaces:

Serializable, Comparable<PluginRestartState>

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 @RequiresRestart annotation on a used module descriptor.

Since:

2.2.0

Enum Constant Summary

Enum Constants

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

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 Detail

values

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

Returns:

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

valueOf

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