org.oddjob.events.state

Enum EventState

java.lang.Object

java.lang.Enum<EventState>

org.oddjob.events.state.EventState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EventState>, State

public enum EventState
extends java.lang.Enum<EventState>
implements State

Encapsulate the allowed states for a InstantEventSource.

Author:

Rob Gordon

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETE The node has stopped subscribing but did receive an event.
CONNECTING The node is connecting to it's event source.
DESTROYED The job has been destroyed.
EXCEPTION Indicates an exception has occurred.
FIRING A node is receiving an event.
INCOMPLETE The node has stopped subscribing but didn't receive an event.
READY The Node is ready to be started.
TRIGGERED An event has arrived but we are still waiting for more.
WAITING A node is waiting for its first event.

Method Summary

Modifier and Type	Method and Description
boolean	isComplete() Is a job or service complete?
boolean	isDestroyed() The job is destroyed.
boolean	isException() Is a job in an exception state.
boolean	isExecuting() Is the job executing.
boolean	isIncomplete() Is a job or service incomplete.
boolean	isReady() Is a job ready to be executed.
boolean	isStoppable() Can a job be stopped? This is a catch all for jobs that are active or executing.
static EventState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EventState[]	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

READY

public static final EventState READY

The Node is ready to be started.

CONNECTING

public static final EventState CONNECTING

The node is connecting to it's event source.

WAITING

public static final EventState WAITING

A node is waiting for its first event.

FIRING

public static final EventState FIRING

A node is receiving an event.

TRIGGERED

public static final EventState TRIGGERED

An event has arrived but we are still waiting for more.

INCOMPLETE

public static final EventState INCOMPLETE

The node has stopped subscribing but didn't receive an event.

COMPLETE

public static final EventState COMPLETE

The node has stopped subscribing but did receive an event.

EXCEPTION

public static final EventState EXCEPTION

Indicates an exception has occurred.

DESTROYED

public static final EventState DESTROYED

The job has been destroyed. It can no longer be used.

Method Detail

values

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

Returns:

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

valueOf

public static EventState valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isReady

public boolean isReady()

Description copied from interface: State

Is a job ready to be executed.

Specified by:

isReady in interface State

Returns:

true/false.

isExecuting

public boolean isExecuting()

Description copied from interface: State

Is the job executing. This is normally when the thread of execution is still within the job.

Specified by:

isExecuting in interface State

Returns:

true/false.

isStoppable

public boolean isStoppable()

Description copied from interface: State

Can a job be stopped? This is a catch all for jobs that are active or executing.

Specified by:

isStoppable in interface State

Returns:

true/false.

isComplete

public boolean isComplete()

Description copied from interface: State

Is a job or service complete?

Specified by:

isComplete in interface State

Returns:

true/false.

isIncomplete

public boolean isIncomplete()

Description copied from interface: State

Is a job or service incomplete. The implication of incomplete is that it could be retried to be complete at some future date.

Specified by:

isIncomplete in interface State

Returns:

true/false.

isException

public boolean isException()

Description copied from interface: State

Is a job in an exception state. This is generally due to an unexpected error, as opposed to incomplete which in some way is expected.

Specified by:

isException in interface State

Returns:

true/false.

isDestroyed

public boolean isDestroyed()

Description copied from interface: State

The job is destroyed. It is no longer available for anything.

Specified by:

isDestroyed in interface State

Returns:

true/false.