com.atlassian.jira.component

Enum ComponentContainerState

java.lang.Object

java.lang.Enum<ComponentContainerState>

com.atlassian.jira.component.ComponentContainerState

All Implemented Interfaces:

Serializable, Comparable<ComponentContainerState>

@ParametersAreNonnullByDefault
public enum ComponentContainerState
extends Enum<ComponentContainerState>

The state of the component container.

Since:

9.7 was an interface inside com.atlassian.jira.component.pico.ComponentManager

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPONENTS_INSTANTIATED All components have been instantiated.
COMPONENTS_REGISTERED All components registered with the DI container including plugin components and plugin system has started.
CONTAINER_INITIALISED Not registered, plugins not started, but container is initialised
NOT_STARTED Not registered, plugins haven't started
PLUGIN_SYSTEM_STARTED Not registered, plugins haven't started
STARTED All components registered with the DI container including plugin components and plugin system has started.

Method Summary

Modifier and Type	Method and Description
String	getMessageKey() Returns the i18n message key for a brief explanation of what the state means.
int	getPercentage() Returns the percentage of the way through the startup process this state can be considered to be.
boolean	isComponentsInstantiated() Have the components been instantiated by the full container.
boolean	isComponentsRegistered() Have the components been registered with the DI container including plugin components.
boolean	isContainerInitialised() Has the DI container been initialised.
boolean	isPluginSystemStarted() Indicates whether the plugin system has been started.
boolean	isStarted() Indicates whether the ComponentManager has been started.
boolean	isValidNewState(ComponentContainerState newState) Indicates whether the given state is a valid next state from this state.
static ComponentContainerState	valueOf(String name) Returns the enum constant of this type with the specified name.
static ComponentContainerState[]	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

NOT_STARTED

public static final ComponentContainerState NOT_STARTED

Not registered, plugins haven't started

CONTAINER_INITIALISED

public static final ComponentContainerState CONTAINER_INITIALISED

Not registered, plugins not started, but container is initialised

PLUGIN_SYSTEM_STARTED

public static final ComponentContainerState PLUGIN_SYSTEM_STARTED

Not registered, plugins haven't started

COMPONENTS_REGISTERED

public static final ComponentContainerState COMPONENTS_REGISTERED

All components registered with the DI container including plugin components and plugin system has started.

COMPONENTS_INSTANTIATED

public static final ComponentContainerState COMPONENTS_INSTANTIATED

All components have been instantiated.

Since:

7.2.5

STARTED

public static final ComponentContainerState STARTED

All components registered with the DI container including plugin components and plugin system has started.

Method Detail

values

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

Returns:

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

valueOf

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

isComponentsInstantiated

public boolean isComponentsInstantiated()

Have the components been instantiated by the full container.

Returns:

true if components have been instantiated by the full container.

isComponentsRegistered

public boolean isComponentsRegistered()

Have the components been registered with the DI container including plugin components.

Returns:

true if components have been registered.

isPluginSystemStarted

public boolean isPluginSystemStarted()

Indicates whether the plugin system has been started.

Returns:

true if the plugin system has started.

isStarted

public boolean isStarted()

Indicates whether the ComponentManager has been started.

Returns:

true if the component manager has started.

isContainerInitialised

public boolean isContainerInitialised()

Has the DI container been initialised.

Returns:

true if the DI container is set up

getMessageKey

public String getMessageKey()

Returns the i18n message key for a brief explanation of what the state means. Note that these translations *must* live in JiraStartupPageSupport.properties. They cannot come from any other source.

Returns:

a message key for resolving a brief description of this state

getPercentage

public int getPercentage()

Returns the percentage of the way through the startup process this state can be considered to be.

Returns:

the startup progress percentage

isValidNewState

public boolean isValidNewState(ComponentContainerState newState)

Indicates whether the given state is a valid next state from this state.

Parameters:

newState - the new state to validate

Returns:

see above