org.agilewiki.jactor.events

Class JAEventQueue<E>

java.lang.Object

org.agilewiki.jactor.events.JAEventQueue<E>

Type Parameters:

E - The type of event.

All Implemented Interfaces:

EventDestination<E>, EventDispatcher<E>, EventQueue<E>

public final class JAEventQueue<E>
extends Object
implements EventQueue<E>

An JAEventQueue receives messages, queues them, and then processes them on another thread.

Constructor Summary

Constructors

Constructor and Description
JAEventQueue(ThreadManager threadManager, boolean autonomous) Creates a JAEventQueue.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	acquireControl(EventQueue<E> eventQueue) Gain control of the queue.
boolean	dispatchEvents() The dispatchEvents method processes any events in the queue.
EventQueue<E>	getController() Returns the controlling queue.
boolean	isEmpty() The isEmpty method returns true when there are no pending events, though the results may not always be correct due to concurrency issues.
void	putEvent(E event) The putEvent method adds an events to the queue of events to be processed and if idle, start the task.
void	relinquishControl() Relinquish foreign control over the queue.
void	setActiveEventProcessor(EventProcessor<E> eventProcessor) Specifies the object which will process the dispatched events.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JAEventQueue

public JAEventQueue(ThreadManager threadManager,
            boolean autonomous)

Creates a JAEventQueue.

Parameters:

threadManager - Provides a thread for processing dispatched events.

autonomous - Inhibits the acquireControl operation when true.

Method Detail

acquireControl

public boolean acquireControl(EventQueue<E> eventQueue)

Gain control of the queue.

Specified by:

acquireControl in interface EventQueue<E>

Parameters:

eventQueue - A queue.

Returns:

True when control was acquired.

relinquishControl

public void relinquishControl()

Relinquish foreign control over the queue.

Specified by:

relinquishControl in interface EventQueue<E>

getController

public EventQueue<E> getController()

Returns the controlling queue.

Specified by:

getController in interface EventQueue<E>

Returns:

The controlling queue.

setActiveEventProcessor

public void setActiveEventProcessor(EventProcessor<E> eventProcessor)

Specifies the object which will process the dispatched events.

Specified by:

setActiveEventProcessor in interface EventDispatcher<E>

Parameters:

eventProcessor - Processes the dispatched events.

isEmpty

public boolean isEmpty()

The isEmpty method returns true when there are no pending events, though the results may not always be correct due to concurrency issues.

Specified by:

isEmpty in interface EventDispatcher<E>

putEvent

public void putEvent(E event)

The putEvent method adds an events to the queue of events to be processed and if idle, start the task.

Specified by:

putEvent in interface EventDestination<E>

Parameters:

event - The events to be processed.

dispatchEvents

public boolean dispatchEvents()

The dispatchEvents method processes any events in the queue. True is returned if any events were actually processed.

Specified by:

dispatchEvents in interface EventDispatcher<E>