Package com.quartetfs.fwk

Enum Class IAgent.State

java.lang.Object

java.lang.Enum<IAgent.State>

com.quartetfs.fwk.IAgent.State

All Implemented Interfaces:

Serializable, Comparable<IAgent.State>, java.lang.constant.Constable

Enclosing interface:

IAgent

public static enum IAgent.State
extends Enum<IAgent.State>

Enumeration of the possible states of an agent.

Author:

ActiveViam

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INIT	The state of an initialized agent.
NONE	The state of an agent that has not been initialized yet.
PAUSED	The state of a paused agent.
STARTED	The state of a started agent.
STOPPED	The state of a stopped agent.
TRANSIENT	An agent is in a transient state when it is in the middle of a state transition.

Method Summary

Modifier and Type	Method	Description
static IAgent.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IAgent.State[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final IAgent.State NONE

The state of an agent that has not been initialized yet.

INIT

public static final IAgent.State INIT

The state of an initialized agent. It has not been started yet.

STARTED

public static final IAgent.State STARTED

The state of a started agent. It is currently active and performing its work.

PAUSED

public static final IAgent.State PAUSED

The state of a paused agent. Its active status has been temporarily suspended, and it won't be performing its work until it is resumed.

STOPPED

public static final IAgent.State STOPPED

The state of a stopped agent. A stopped agent is "shut down". It won't perform any work anymore and cannot be re-started.

TRANSIENT

public static final IAgent.State TRANSIENT

An agent is in a transient state when it is in the middle of a state transition. An agent in a transient state is not allowed to enter another state transition until it is back to a "regular" state.

Method Details

values

public static IAgent.State[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static IAgent.State valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null