Package org.apache.qpid.protonj2.engine

Enum EngineState

java.lang.Object

java.lang.Enum<EngineState>

org.apache.qpid.protonj2.engine.EngineState

All Implemented Interfaces:

Serializable, Comparable<EngineState>

public enum EngineState
extends Enum<EngineState>

Enumeration of Engine states as visible from the Engine API

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAILED	The engine has encountered an error and is no longer usable.
IDLE	The engine has not been started yet and is safe to configure.
SHUTDOWN	The engine has been shutdown and can no longer be used.
SHUTTING_DOWN	Engine is shutting down and all pending work should be completed.
STARTED	The engine has been started and no changes to configuration are permissible.
STARTING	Indicates the engine is in the starting phase and configuration be safe to use now.

Method Summary

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

IDLE

public static final EngineState IDLE

The engine has not been started yet and is safe to configure.

STARTING

public static final EngineState STARTING

Indicates the engine is in the starting phase and configuration be safe to use now.

STARTED

public static final EngineState STARTED

The engine has been started and no changes to configuration are permissible.

FAILED

public static final EngineState FAILED

The engine has encountered an error and is no longer usable.

SHUTTING_DOWN

public static final EngineState SHUTTING_DOWN

Engine is shutting down and all pending work should be completed.

SHUTDOWN

public static final EngineState SHUTDOWN

The engine has been shutdown and can no longer be used.

Method Detail

values

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

Returns:

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

valueOf

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