com.atlassian.plugin.manager

Class DefaultPluginPersistentState

java.lang.Object

com.atlassian.plugin.manager.DefaultPluginPersistentState

All Implemented Interfaces:

PluginPersistentState, Serializable

public final class DefaultPluginPersistentState
extends Object
implements Serializable, PluginPersistentState

Immutable implementation of the PluginPersistentState interface.

The state stored in this object represents only the differences between the desired state and the default state configured in the plugin. So if "getPluginState()" or "getPluginModuleState()" return null, then the manager should assume that the default state applies instead.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.plugin.manager.PluginPersistentState

PluginPersistentState.Builder, PluginPersistentState.Util

Constructor Summary

Constructors

Constructor and Description
DefaultPluginPersistentState() Deprecated. create PluginPersistentState instances using the PluginPersistentState.Builder
DefaultPluginPersistentState(Map<String,Boolean> map) Deprecated. create PluginPersistentState instances using the PluginPersistentState.Builder
DefaultPluginPersistentState(PluginPersistentState state) Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Boolean>	getMap() Get the map of all states.
PluginRestartState	getPluginRestartState(String pluginKey) Gets whether the plugin is expected to be upgraded, installed, or removed on next restart
Map<String,Boolean>	getPluginStateMap(Plugin plugin) Get state map of the given plugin and its modules
boolean	isEnabled(ModuleDescriptor<?> pluginModule) Whether or not a given plugin module is enabled in this state, calculated from it's current state AND default state.
boolean	isEnabled(Plugin plugin) Whether or not a plugin is enabled, calculated from it's current state AND default state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultPluginPersistentState

@Deprecated
public DefaultPluginPersistentState()

Deprecated. create PluginPersistentState instances using the PluginPersistentState.Builder

Creates an empty PluginPersistentState.

DefaultPluginPersistentState

@Deprecated
public DefaultPluginPersistentState(Map<String,Boolean> map)

Deprecated. create PluginPersistentState instances using the PluginPersistentState.Builder

Creates a PluginPersistentState with the supplied states.

Parameters:

map - of the plugin states using the Plugin.getKey() as the key.

DefaultPluginPersistentState

@Deprecated
public DefaultPluginPersistentState(PluginPersistentState state)

Deprecated.

Copy constructor. Doesn't make sense to use as the map is immutable. Just use the

Parameters:

state -

Method Detail

getMap

public Map<String,Boolean> getMap()

Description copied from interface: PluginPersistentState

Get the map of all states.

Specified by:

getMap in interface PluginPersistentState

Returns:

The map that maps plugins and modules' keys to a state (Boolean.True/Boolean.False). State stored in this map represents only the differences between the current state and the default state configured in the plugin(module).

isEnabled

public boolean isEnabled(Plugin plugin)

Description copied from interface: PluginPersistentState

Whether or not a plugin is enabled, calculated from it's current state AND default state.

Specified by:

isEnabled in interface PluginPersistentState

isEnabled

public boolean isEnabled(ModuleDescriptor<?> pluginModule)

Description copied from interface: PluginPersistentState

Whether or not a given plugin module is enabled in this state, calculated from it's current state AND default state.

Specified by:

isEnabled in interface PluginPersistentState

getPluginStateMap

public Map<String,Boolean> getPluginStateMap(Plugin plugin)

Description copied from interface: PluginPersistentState

Get state map of the given plugin and its modules

Specified by:

getPluginStateMap in interface PluginPersistentState

Returns:

The map that maps the plugin and its modules' keys to plugin state (Boolean.TRUE/Boolean.FALSE). State stored in this map represents only the differences between the current state and the default state configured in the plugin(module).

getPluginRestartState

public PluginRestartState getPluginRestartState(String pluginKey)

Description copied from interface: PluginPersistentState

Gets whether the plugin is expected to be upgraded, installed, or removed on next restart

Specified by:

getPluginRestartState in interface PluginPersistentState

Parameters:

pluginKey - The plugin to query

Returns:

The state of the plugin on restart