de.must.middle

Class InterruptibleBatchThread

java.lang.Object

java.lang.Thread

de.must.middle.MustThread

de.must.middle.InterruptibleThread

de.must.middle.InterruptibleBatchThread

All Implemented Interfaces:

BatchControllable, Controllable, CoreRunnable, Exemptible, ExemptibleManager, java.lang.Runnable

Direct Known Subclasses:

CumulationReport, FileOutputThread, GenericInterruptibleThread, ProportionalListReportDirectly

public abstract class InterruptibleBatchThread
extends InterruptibleThread
implements BatchControllable, CoreRunnable

Interruptible batch thread. Such a thread may have different these states - not running yet - active and processing real work - active but idling - termination requested but processing real work (between two isToRun()) - terminated - it will end after informing listeners The interruption will be done after a process step is finished whenever possible

See Also:

A different concept is to define interruptible processes without immediate decision to run them in an own thread, see {@link InterruptibleProcess2}. Thus, the same process can be performed inside a thread or sequentially, dependent on the context., DesktopProcessRunner, ServerProcessRunner

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 SessionResources	sessionResources

Fields inherited from class de.must.middle.InterruptibleThread

threadController

Fields inherited from class de.must.middle.MustThread

threadDoneListeners

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Fields inherited from interface de.must.middle.BatchControllable

GROUP_TERMINATION_ALLOWED_WITHOUT_CONFIRMATION, GROUP_TERMINATION_NOT_ALLOWED, GROUP_TERMINATION_REQUIRES_CONFIRMATION

Constructor Summary

Constructors

Constructor and Description
InterruptibleBatchThread(SessionResources sessionResources) Constructs a new interruptible batch thread.
InterruptibleBatchThread(SessionResources sessionResources, boolean terminationRequiresUserConfirmation) Constructs a new interruptible batch thread.
InterruptibleBatchThread(SessionResources sessionResources, java.lang.String name) Constructs a new interruptible batch thread.

Method Summary

Modifier and Type	Method and Description
SessionResources	getSessionResources()
protected boolean	isTerminationRequested() Returns true if termination is requested.
boolean	isToRun() Returns true if the thread is to be continued.
boolean	requiresUserConfirmationToTerminate() Returns true of process requires user confirmation to terminate it.
void	runCore() Runs the core functionality to be defined by sub class.
void	setTerminationRequiresUserConfirmation(boolean b)
void	start() Causes this thread to begin execution; the Java Virtual Machine calls the run method of this thread.
void	terminate() Terminates the thread.

Methods inherited from class de.must.middle.InterruptibleThread

free, register, register, run, runPartAfterCore, setStatusInformation, setThreadController

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, 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.BatchControllable

getName

Methods inherited from interface de.must.middle.Controllable

addThreadDoneListener, setThreadController

Methods inherited from interface de.must.middle.CoreRunnable

runCore

Field Detail

sessionResources

protected SessionResources sessionResources

Constructor Detail

InterruptibleBatchThread

public InterruptibleBatchThread(SessionResources sessionResources)

Constructs a new interruptible batch thread.

Parameters:

sessionResources - the session resources to use

InterruptibleBatchThread

public InterruptibleBatchThread(SessionResources sessionResources,
                                java.lang.String name)

Constructs a new interruptible batch thread.

Parameters:

sessionResources - the session resources to use

name - the name of the thread - describing what it is doing

InterruptibleBatchThread

public InterruptibleBatchThread(SessionResources sessionResources,
                                boolean terminationRequiresUserConfirmation)

Constructs a new interruptible batch thread.

Parameters:

sessionResources - the session resources to use

terminationAtAnyTime - whether or not this thread requires explicit user confirmation to terminaten it

Method Detail

setTerminationRequiresUserConfirmation

public void setTerminationRequiresUserConfirmation(boolean b)

requiresUserConfirmationToTerminate

public boolean requiresUserConfirmationToTerminate()

Description copied from interface: BatchControllable

Returns true of process requires user confirmation to terminate it.

Specified by:

requiresUserConfirmationToTerminate in interface BatchControllable

Returns:

true of process requires user confirmation to terminate it

getSessionResources

public SessionResources getSessionResources()

start

public void start()

Description copied from interface: Controllable

Causes this thread to begin execution; the Java Virtual Machine calls the run method of this thread.

The result is that two threads are running concurrently: the current thread (which returns from the call to the start method) and the other thread (which executes its run method).

Specified by:

start in interface Controllable

Overrides:

start in class java.lang.Thread

See Also:

Thread.run()

runCore

public final void runCore()

Description copied from interface: Controllable

Runs the core functionality to be defined by sub class.

Specified by:

runCore in interface Controllable

isToRun

public boolean isToRun()

Description copied from class: InterruptibleThread

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 InterruptibleThread

Returns:

true if the thread is to be continued

terminate

public void terminate()

Description copied from interface: BatchControllable

Terminates the thread.

Specified by:

terminate in interface BatchControllable

isTerminationRequested

protected boolean isTerminationRequested()

Returns true if termination is requested.

Returns:

true if termination is requested