net.sf.eBus.util

Enum EventThread.RunState

java.lang.Object

java.lang.Enum<EventThread.RunState>

net.sf.eBus.util.EventThread.RunState

All Implemented Interfaces:

Serializable, Comparable<EventThread.RunState>

Enclosing class:

EventThread

public static enum EventThread.RunState
extends Enum<EventThread.RunState>

An EventThread has seven distinct states:

1. NOT_STARTED: The EventThread was instantiated but not yet started.
2. STARTING: An EventThread is instantiated and start() is executing but not yet completed.
3. RUNNING: An EventThread instance was started but EventThread.halt(boolean) or EventThread.haltNow(boolean) have not yet been called.
4. HALT_DRAIN: EventThread.halt(boolean) was called and the the EventThread is processing existing enqueued events. No new events may be added.
5. HALT_NOW: EventThread.haltNow(boolean) was called; all enqueued events are ignored.
6. STOPPING: An EventThread has exited the event processing thread and called the stopping method.
7. HALTED: An EventThread has exited its run method.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HALT_DRAIN The thread is waiting for the queue to drain before halting.
HALT_NOW The thread is stopping now.
HALTED The event thread has completed its clean up performed by the stopping method and is no longer running.
NOT_STARTED The event thread is not yet started.
RUNNING The thread is processing events.
STARTING The event thread is calling the subclass starting() method.
STOPPING The event thread has stopped processing the event queue and has passed control to the subclass stopping method.

Method Summary

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

The event thread is not yet started.

STARTING

public static final EventThread.RunState STARTING

The event thread is calling the subclass starting() method.

RUNNING

public static final EventThread.RunState RUNNING

The thread is processing events.

HALT_DRAIN

public static final EventThread.RunState HALT_DRAIN

The thread is waiting for the queue to drain before halting.

HALT_NOW

public static final EventThread.RunState HALT_NOW

The thread is stopping now.

STOPPING

public static final EventThread.RunState STOPPING

The event thread has stopped processing the event queue and has passed control to the subclass stopping method.

HALTED

public static final EventThread.RunState HALTED

The event thread has completed its clean up performed by the stopping method and is no longer running. This thread may not be restarted.

Method Detail

values

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

Returns:

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

valueOf

public static EventThread.RunState 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