rescuecore2.misc

Class WorkerThread

java.lang.Object

java.lang.Thread

rescuecore2.misc.WorkerThread

All Implemented Interfaces:

java.lang.Runnable

public abstract class WorkerThread
extends java.lang.Thread

Abstract class for threads that need to repeat a unit of work, for example listening on a socket and dispatching data to listeners.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
WorkerThread() Construct a worker thread.

Method Summary

Modifier and Type	Method and Description
protected void	cleanup() Perform any cleanup necessary after work finishes.
boolean	isRunning() Find out if this thread is still running.
void	kill() Interrupt any current work, tell the thread to stop and wait for the thread to die.
void	run()
protected void	setup() Perform any setup necessary before work begins.
protected abstract boolean	work() Do a unit of work and return whether there is more work to be done.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkerThread

public WorkerThread()

Construct a worker thread.

Method Detail

kill

public void kill()
          throws java.lang.InterruptedException

Interrupt any current work, tell the thread to stop and wait for the thread to die.

Throws:

java.lang.InterruptedException - If the thread that called kill is itself interrupted.

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

isRunning

public boolean isRunning()

Find out if this thread is still running. If kill() has been called (and returned) or if work() has returned false then this worker thread is not still running.

Returns:

True if it is still running and has not been killed, false otherwise.

work

protected abstract boolean work()
                         throws java.lang.InterruptedException

Do a unit of work and return whether there is more work to be done. Implementations should check periodically for interruptions and throw an exception when required.

Returns:

True if more work remains, false otherwise.

Throws:

java.lang.InterruptedException - If the worker thread is interrupted.

setup

protected void setup()

Perform any setup necessary before work begins. Default implementation does nothing.

cleanup

protected void cleanup()

Perform any cleanup necessary after work finishes. This will be called even if the work() method throws an exception. It is highly recommended that this method does not throw any exceptions. Default implementation does nothing.