no.g9.client.support

Class G9Worker

java.lang.Object

no.g9.client.support.G9Worker

public class G9Worker
extends Object

A class for creating a queue of Runnables.

The runnables are executed in a FIFO fashion.

Method Summary

Modifier and Type	Method and Description
void	enqueue(Runnable task) Puts a task on the queue.
static G9Worker	enqueueTask(Object controller, Runnable task) Thread-safe enqueuing of task on a G9Worker.
static G9Worker	getWorker(Object controller) Returns an instance of G9Worker.
boolean	isEmpty() Returns true if this workers queue is empty
boolean	isRunning() Returns true if this worker is currently doing a task.
void	relinquish() Removes all tasks from the queue, and stops the worker.
boolean	waitOnQueue() Waits on all tasks in the queue to finish before returning.

Methods inherited from class java.lang.Object

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

Method Detail

enqueueTask

public static G9Worker enqueueTask(Object controller,
                                   Runnable task)

Thread-safe enqueuing of task on a G9Worker.

Parameters:

controller - the controlling object

task - the task to enqueue

Returns:

the G9Worker responsible for invoking the task.

See Also:

getWorker(Object), enqueue(Runnable)

getWorker

public static G9Worker getWorker(Object controller)

Returns an instance of G9Worker. Ensures that at most one instance is created for each controller. Note that g9 Workers must be shut down manually using relinquish(). Failing to do so will result in a memory leak.

Parameters:

controller - the controller "owning" the worker

Returns:

an instance of G9Worker

See Also:

enqueueTask(Object, Runnable)

waitOnQueue

public boolean waitOnQueue()

Waits on all tasks in the queue to finish before returning. If the worker is interrupted while the calling thread of this method is waiting, the return value is false, otherwise, the method waits until all task on the queue is finished and no current task is executed, and then returns true

Returns:

true if all task are finished

enqueue

public void enqueue(Runnable task)

Puts a task on the queue.

Parameters:

task - the task that is put on the queue.

See Also:

enqueueTask(Object, Runnable)

relinquish

public void relinquish()

Removes all tasks from the queue, and stops the worker. After the worker is relinquished, you should not enqueue any further tasks, unless you create a new worker (using the getWorker() method).

isRunning

public boolean isRunning()

Returns true if this worker is currently doing a task.

Returns:

true if worker is doing a task

isEmpty

public boolean isEmpty()

Returns true if this workers queue is empty

Returns:

true if workers queue is empty