jalse.actions

Class ManualWorkQueue<T extends AbstractManualActionContext<?>>

java.lang.Object

jalse.actions.ManualWorkQueue<T>

Type Parameters:

T - Actor type.

public class ManualWorkQueue<T extends AbstractManualActionContext<?>>
extends java.lang.Object

A thread-safe queue for AbstractManualActionContext using the estimated perform time ( AbstractManualActionContext.getEstimated()). This is a convenience class for creating an ActionEngine.

See Also:

ManualActionEngine, ForkJoinActionEngine

Constructor Summary

Constructors

Constructor and Description
ManualWorkQueue() Creates a new instance of ManualWorkQueue.

Method Summary

Modifier and Type	Method and Description
boolean	addWaitingWork(T context) Adds work to the queue.
void	awaitNextReadyWork() Awaits until the next work is ready (or the work queue is empty).
java.util.List<? extends T>	getWaitingWork() Gets all waiting work in the queue.
boolean	isWaitingWork(T context) Whether the work is contained in the queue.
boolean	isWorkReady() Whether there is work ready.
boolean	isWorkWaiting() Whether the queue has waiting work.
T	pollReadyWork() Polls for ready work (removes if work is available).
void	removeAllWaitingWork() Clears waiting work.
boolean	removeWaitingWork(T context) Removes work from the queue.
int	waitingWorkSize() Gets the waiting work count.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManualWorkQueue

public ManualWorkQueue()

Creates a new instance of ManualWorkQueue.

Method Detail

addWaitingWork

public boolean addWaitingWork(T context)

Adds work to the queue.

Parameters:

context - Work to add.

Returns:

Whether the work was not previously within the queue.

awaitNextReadyWork

public void awaitNextReadyWork()
                        throws java.lang.InterruptedException

Awaits until the next work is ready (or the work queue is empty).

Throws:

java.lang.InterruptedException - Whether the wait is interrupted.

getWaitingWork

public java.util.List<? extends T> getWaitingWork()

Gets all waiting work in the queue.

Returns:

All waiting work.

isWaitingWork

public boolean isWaitingWork(T context)

Whether the work is contained in the queue.

Parameters:

context - Work to check.

Returns:

Whether the work was already waiting.

isWorkReady

public boolean isWorkReady()

Whether there is work ready.

Returns:

Whether work is ready.

isWorkWaiting

public boolean isWorkWaiting()

Whether the queue has waiting work.

Returns:

Whether the queue is not empty.

pollReadyWork

public T pollReadyWork()

Polls for ready work (removes if work is available).

Returns:

Work if available (or else null).

removeAllWaitingWork

public void removeAllWaitingWork()

Clears waiting work.

removeWaitingWork

public boolean removeWaitingWork(T context)

Removes work from the queue.

Parameters:

context - Work to remove.

Returns:

Whether the work was already in the queue.

waitingWorkSize

public int waitingWorkSize()

Gets the waiting work count.

Returns:

Work count.