Class HaltingThread

java.lang.Object

java.lang.Thread

org.apache.batik.util.HaltingThread

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

GVTTreeBuilder, GVTTreeRenderer, SVGDocumentLoader, SVGLoadEventDispatcher

public class HaltingThread
extends Thread

This is a subclass of java.lang.Thread that includes a non-intrusive 'halt' method. The Halt method simply sets a boolean that can be checked periodically during expensive processing.

Version:

$Id$

Nested Class Summary

Nested classes/interfaces inherited from class Thread

Thread.Builder, Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	beenHalted	Boolean indicating if this thread has ever been 'halted'.

Fields inherited from class Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor	Description
HaltingThread()
HaltingThread(Runnable r)
HaltingThread(Runnable r, String name)
HaltingThread(String name)

Method Summary

Modifier and Type	Method	Description
void	clearHalted()	Set's beenHalted to false.
void	halt()	Set's beenHalted to true.
static void	haltThread()	Calls 'halt' on Thread.currentThread() if it is an instance of HaltingThread otherwise it does nothing.
static void	haltThread(Thread t)	Calls 'halt' on t if it is an instance of HaltingThread otherwise it does nothing.
static boolean	hasBeenHalted()	Returns the result of calling hasBeenHalted on Thread.currentThread(), if it is an instance of HaltingThread otherwise it returns false.
static boolean	hasBeenHalted(Thread t)	Returns the result of calling hasBeenHalted on t, if it is an instance of HaltingThread otherwise it returns false.
boolean	isHalted()	returns true if someone has halted the thread.

Methods inherited from class Thread

activeCount, checkAccess, clone, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, isVirtual, join, join, join, join, ofPlatform, ofVirtual, onSpinWait, run, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, sleep, start, startVirtualThread, stop, threadId, toString, yield

Methods inherited from class Object

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

Field Details

beenHalted

protected boolean beenHalted

Boolean indicating if this thread has ever been 'halted'.

Constructor Details

HaltingThread

public HaltingThread()

HaltingThread

public HaltingThread(Runnable r)

HaltingThread

public HaltingThread(String name)

HaltingThread

public HaltingThread(Runnable r,
 String name)

Method Details

isHalted

public boolean isHalted()

returns true if someone has halted the thread.

halt

public void halt()

Set's beenHalted to true.

clearHalted

public void clearHalted()

Set's beenHalted to false.

haltThread

public static void haltThread()

Calls 'halt' on Thread.currentThread() if it is an instance of HaltingThread otherwise it does nothing.

haltThread

public static void haltThread(Thread t)

Calls 'halt' on t if it is an instance of HaltingThread otherwise it does nothing.

hasBeenHalted

public static boolean hasBeenHalted()

Returns the result of calling hasBeenHalted on Thread.currentThread(), if it is an instance of HaltingThread otherwise it returns false.

hasBeenHalted

public static boolean hasBeenHalted(Thread t)

Returns the result of calling hasBeenHalted on t, if it is an instance of HaltingThread otherwise it returns false.