Class CancellableThread

java.lang.Object

java.lang.Thread

com.xinapse.util.CancellableThread

All Implemented Interfaces:

Runnable

public abstract class CancellableThread
extends Thread

A class to implement a cancellable Thread. Thread cancellation is achieved by setting the flag. It is up to the thread's run method to check this flag periodically and return if set.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CancellableThread.Flag	A flag that can be set to indicate that a cancellation has taken place.

Nested classes/interfaces inherited from class Thread

Thread.Builder, Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CANCELLED_MESSAGE	A String used to report cancellation.
static final String	INTERRUPTED_MESSAGE	A String used to report interruption.
static final String	UNEXPECTED_CANCELLATION_MESSAGE	A String used to report unexpected cancellation.

Fields inherited from class Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Method Summary

Modifier and Type	Method	Description
void	cancel()	Signal the CancellableThread to stop any processing and return.
boolean	isCancelled()	Tests whether this CancellableThread has been cancelled.
void	run()

Methods inherited from class Thread

activeCount, checkAccess, 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, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, sleep, start, startVirtualThread, stop, threadId, toString, yield

Methods inherited from class Object

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

Field Details

CANCELLED_MESSAGE

public static final String CANCELLED_MESSAGE

A String used to report cancellation.

See Also:

• Constant Field Values

INTERRUPTED_MESSAGE

public static final String INTERRUPTED_MESSAGE

A String used to report interruption.

See Also:

• Constant Field Values

UNEXPECTED_CANCELLATION_MESSAGE

public static final String UNEXPECTED_CANCELLATION_MESSAGE

A String used to report unexpected cancellation.

See Also:

• Constant Field Values

Method Details

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

cancel

public void cancel()

Signal the CancellableThread to stop any processing and return.

isCancelled

public boolean isCancelled()

Tests whether this CancellableThread has been cancelled.

Returns:

true if this CancellableThread has been cancelled by the user; false otherwise.