Package com.atlassian.plugin.manager

Interface PluginPersistentState

All Superinterfaces:

StoredPluginState

All Known Implementing Classes:

DefaultPluginPersistentState

public interface PluginPersistentState
extends StoredPluginState

Interface that represents a configuration state for plugins and plugin modules. The configuration state (enabled or disabled) is separate from the plugins and modules themselves because a plugin may have multiple states depending on the context.

Since:

2.2.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	PluginPersistentState.Builder	Builder for PluginPersistentState instances.
static class	PluginPersistentState.Util

Method Summary

Modifier and Type	Method	Description
static PluginPersistentState.Builder	builder()
static PluginPersistentState.Builder	builder(PluginPersistentState state)
default Map<String,Boolean>	getMap()	Deprecated. please use StoredPluginState.getStatesMap() instead
default Map<String,Boolean>	getPluginStateMap(Plugin plugin)	Deprecated. please use StoredPluginState.getPluginEnabledStateMap(Plugin) instead

Methods inherited from interface com.atlassian.plugin.StoredPluginState

getPluginEnabledStateMap, getPluginRestartState, getStatesMap, isEnabled, isEnabled

Method Details

builder

static PluginPersistentState.Builder builder()

Returns:

a new builder

Since:

5.0

builder

static PluginPersistentState.Builder builder(PluginPersistentState state)

Returns:

a new builder that is initialized with the provided state

Since:

5.0

getMap

@Deprecated
default Map<String,Boolean> getMap()

Deprecated.

please use StoredPluginState.getStatesMap() instead

Get the map of all states. Deprecated since 4.5.0

Returns:

The map that maps plugins and modules' keys to an actual enabled state (Boolean.True/Boolean.False).

getPluginStateMap

@Deprecated
default Map<String,Boolean> getPluginStateMap(Plugin plugin)

Deprecated.

please use StoredPluginState.getPluginEnabledStateMap(Plugin) instead

Get state map of the given plugin and its modules. Deprecated since 4.5.0

Parameters:

plugin - the plugin

Returns:

The map that maps the plugin and its modules' keys to plugin state (Boolean.TRUE/Boolean.FALSE).