de.must.middle

Class MustThread

java.lang.Object

java.lang.Thread

de.must.middle.MustThread

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

ActionQueue, EventQueueOccupationChecker, InterruptibleThread, ReportPresentationTask, RFIDController, WordProceedTask

public class MustThread
extends java.lang.Thread

Thread with basic additional functionality of perpus.de, e.g. handling thread done events.

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector<ThreadDoneListener>	threadDoneListeners

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
MustThread()
MustThread(java.lang.Runnable target)
MustThread(java.lang.Runnable target, java.lang.String name)
MustThread(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	addThreadDoneListener(ThreadDoneListener l) Adds the specified ThreadDoneListener to receive thread done events.
protected void	fireThreadDone()
protected void	fireThreadDone(java.lang.Exception exception)
java.lang.String	getEventMessage() Returns the event message (error message).
protected int	getFinalState() Returns the final state of the thread.
protected void	idle(int millies) Let the thread sleep - use this method instead of Thread's sleep method to let the application know that there are no real processes at the moment.
boolean	isToRun() Returns true if the thread is to be continued.
protected void	logDebug(java.lang.String text) Logs a message as a debug information.
protected void	logError(java.lang.String text, java.lang.Throwable throwable) Logs a message as an error.
protected void	logError(java.lang.Throwable throwable) Logs a message as an error.
protected void	logInfo(java.lang.String text) Logs a message as information.
void	setEventErrorMessage(java.lang.String eventMessage) Sets the eventErrorMessage and indicate that the thread is not successful.
void	setEventMessage(java.lang.String eventMessage) Sets the eventMessage.
protected void	setFinalState(int finalState) Sets the final state of the thread.

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, run, 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

Field Detail

threadDoneListeners

protected java.util.Vector<ThreadDoneListener> threadDoneListeners

Constructor Detail

MustThread

public MustThread()

MustThread

public MustThread(java.lang.String name)

MustThread

public MustThread(java.lang.Runnable target)

MustThread

public MustThread(java.lang.Runnable target,
                  java.lang.String name)

Method Detail

addThreadDoneListener

public void addThreadDoneListener(ThreadDoneListener l)

Adds the specified ThreadDoneListener to receive thread done events.

See Also:

ThreadDoneEvent

fireThreadDone

protected void fireThreadDone()

fireThreadDone

protected void fireThreadDone(java.lang.Exception exception)

setEventErrorMessage

public void setEventErrorMessage(java.lang.String eventMessage)

Sets the eventErrorMessage and indicate that the thread is not successful.

Parameters:

eventMessage - The eventMessage to set

setFinalState

protected void setFinalState(int finalState)

Sets the final state of the thread.

Parameters:

finalState - the final state of the thread

See Also:

ThreadDoneEvent.FINAL_STATE_SUCCESSFUL, ThreadDoneEvent.FINAL_STATE_CANCELED, ThreadDoneEvent.FINAL_STATE_FAILED

getFinalState

protected int getFinalState()

Returns the final state of the thread.

Returns:

the final state of the thread

See Also:

ThreadDoneEvent.FINAL_STATE_SUCCESSFUL, ThreadDoneEvent.FINAL_STATE_CANCELED, ThreadDoneEvent.FINAL_STATE_FAILED

setEventMessage

public void setEventMessage(java.lang.String eventMessage)

Sets the eventMessage.

Parameters:

eventMessage - The eventMessage to set

getEventMessage

public java.lang.String getEventMessage()

Returns the event message (error message).

Returns:

the event message (error message)

logDebug

protected void logDebug(java.lang.String text)

Logs a message as a debug information.

Parameters:

text - the message to log

logInfo

protected void logInfo(java.lang.String text)

Logs a message as information.

Parameters:

text - the message to log

logError

protected void logError(java.lang.Throwable throwable)

Logs a message as an error.

Parameters:

throwable - the exception to log

logError

protected void logError(java.lang.String text,
                        java.lang.Throwable throwable)

Logs a message as an error.

Parameters:

text - the message (text) to log

throwable - the exception to log

isToRun

public boolean isToRun()

Returns true if the thread is to be continued.

Returns:

true if the thread is to be continued

idle

protected void idle(int millies)

Let the thread sleep - use this method instead of Thread's sleep method to let the application know that there are no real processes at the moment.

Parameters:

millies - the length of time to sleep in milliseconds