com.atlassian.jira.com.rproxy.goskope.component.pico

Enum ComponentManagerStateImpl

java.lang.Object

java.lang.Enum<ComponentManagerStateImpl>

com.atlassian.jira.com.rproxy.goskope.component.pico.ComponentManagerStateImpl

All Implemented Interfaces:

ComponentManager.State, Serializable, Comparable<ComponentManagerStateImpl>

@ParametersAreNonnullByDefault
public enum ComponentManagerStateImpl
extends Enum<ComponentManagerStateImpl>
implements ComponentManager.State

An implementation of ComponentManager.State interface

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPONENTS_INSTANTIATED All components have been instantiated.
COMPONENTS_REGISTERED All components registered with PICO 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 PICO including plugin components and plugin system has started.

Method Summary

Modifier and Type	Method and Description
String	getMessageKey() Gets a translation key for getting 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 registered been with PICO including plugin components.
boolean	isContainerInitialised() Has the PICO container initialised.
boolean	isPluginSystemStarted() Have the components registered been with PICO including plugin components.
boolean	isStarted() Has the ComponentManager started
boolean	isValidNewState(ComponentManagerStateImpl newState) Indicates whether the given state is a valid next state from this state.
static ComponentManagerStateImpl	valueOf(String name) Returns the enum constant of this type with the specified name.
static ComponentManagerStateImpl[]	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 ComponentManagerStateImpl NOT_STARTED

Not registered, plugins haven't started

CONTAINER_INITIALISED

public static final ComponentManagerStateImpl CONTAINER_INITIALISED

Not registered, plugins not started, but container is initialised

PLUGIN_SYSTEM_STARTED

public static final ComponentManagerStateImpl PLUGIN_SYSTEM_STARTED

Not registered, plugins haven't started

COMPONENTS_REGISTERED

public static final ComponentManagerStateImpl COMPONENTS_REGISTERED

All components registered with PICO including plugin components and plugin system has started.

COMPONENTS_INSTANTIATED

public static final ComponentManagerStateImpl COMPONENTS_INSTANTIATED

All components have been instantiated.

Since:

7.2.5

STARTED

public static final ComponentManagerStateImpl STARTED

All components registered with PICO including plugin components and plugin system has started.

Method Detail

values

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

Returns:

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

valueOf

public static ComponentManagerStateImpl 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()

Description copied from interface: ComponentManager.State

Have the components been instantiated by the full container.

Specified by:

isComponentsInstantiated in interface ComponentManager.State

Returns:

true if components have been instantiated by the full container.

isComponentsRegistered

public boolean isComponentsRegistered()

Description copied from interface: ComponentManager.State

Have the components registered been with PICO including plugin components.

Specified by:

isComponentsRegistered in interface ComponentManager.State

Returns:

true if components have been registered.

isPluginSystemStarted

public boolean isPluginSystemStarted()

Description copied from interface: ComponentManager.State

Have the components registered been with PICO including plugin components.

Specified by:

isPluginSystemStarted in interface ComponentManager.State

Returns:

true if the plugin system has started.

isStarted

public boolean isStarted()

Description copied from interface: ComponentManager.State

Has the ComponentManager started

Specified by:

isStarted in interface ComponentManager.State

Returns:

true if the component manager has started.

isContainerInitialised

public boolean isContainerInitialised()

Description copied from interface: ComponentManager.State

Has the PICO container initialised.

Specified by:

isContainerInitialised in interface ComponentManager.State

Returns:

true if the PICO container is set up

getMessageKey

public String getMessageKey()

Description copied from interface: ComponentManager.State

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

Specified by:

getMessageKey in interface ComponentManager.State

Returns:

a message key for resolving a brief description of this state

getPercentage

public int getPercentage()

Description copied from interface: ComponentManager.State

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

Specified by:

getPercentage in interface ComponentManager.State

Returns:

the startup progress percentage

isValidNewState

public boolean isValidNewState(ComponentManagerStateImpl newState)

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

Parameters:

newState - the new state to validate

Returns:

see above