de.must.middle

Class InterruptibleThread

java.lang.Object

java.lang.Thread

de.must.middle.MustThread

de.must.middle.InterruptibleThread

All Implemented Interfaces:

Controllable, Exemptible, ExemptibleManager, java.lang.Runnable

Direct Known Subclasses:

ImageLoader, InactivityWatcher, InterruptibleBatchThread

public abstract class InterruptibleThread
extends MustThread
implements Controllable, ExemptibleManager

Thread with functions to interrupt it by a controller.

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 ThreadController	threadController

Fields inherited from class de.must.middle.MustThread

threadDoneListeners

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	free() Releases external resources.
boolean	isToRun() Returns true if the thread is to be continued.
DataObject	register(DataObject dataObject) Registers an object to free its external resources as soon as they are not needed any more.
void	register(Exemptible exemptible) Registers an object to free its external resources as soon as they are not needed any more.
void	run()
protected void	runPartAfterCore()
void	setStatusInformation(java.lang.String statusInformation) Sets the status information to be transfered to the user if there is a controller for it.
void	setThreadController(ThreadController threadController) Set the thread controller.

Methods inherited from class de.must.middle.MustThread

addThreadDoneListener, fireThreadDone, fireThreadDone, getEventMessage, getFinalState, idle, logDebug, logError, logError, logInfo, setEventErrorMessage, setEventMessage, setFinalState

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

Methods inherited from interface de.must.middle.Controllable

addThreadDoneListener, runCore, start

Field Detail

threadController

protected ThreadController threadController

Constructor Detail

InterruptibleThread

public InterruptibleThread()

InterruptibleThread

public InterruptibleThread(java.lang.String name)

InterruptibleThread

public InterruptibleThread(java.lang.Runnable target)

InterruptibleThread

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

Method Detail

setThreadController

public void setThreadController(ThreadController threadController)

Set the thread controller.

Specified by:

setThreadController in interface Controllable

Parameters:

threadController - the thread controller to use.

register

public void register(Exemptible exemptible)

Description copied from interface: ExemptibleManager

Registers an object to free its external resources as soon as they are not needed any more. The purpose of this registration is to ensure that already during the construction of this object, that certain resources are automatically released at a suitable later moment.

Specified by:

register in interface ExemptibleManager

Parameters:

exemptible - the exemptible object to register

register

public DataObject register(DataObject dataObject)

Registers an object to free its external resources as soon as they are not needed any more. The purpose of this registration is to ensure that already during the construction of this object, that certain resources are automatically released at a suitable later moment.

Parameters:

dataObject - the data object to register to be released at a suitable later moment

Returns:

the data object - this, this method can be included in nested instructions

isToRun

public boolean isToRun()

Returns true if the thread is to be continued. Is answered no if user clicked the controller's cancel button meanwhile.

Overrides:

isToRun in class MustThread

Returns:

true if the thread is to be continued

setStatusInformation

public void setStatusInformation(java.lang.String statusInformation)

Sets the status information to be transfered to the user if there is a controller for it.

Parameters:

message - the status information for the user

run

public final void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

runPartAfterCore

protected void runPartAfterCore()

free

public void free()

Description copied from interface: ExemptibleManager

Releases external resources. May be called manually without waiting for garbage collection to occur.

Specified by:

free in interface Exemptible

Specified by:

free in interface ExemptibleManager