freemind.common

Class FreeMindTask

java.lang.Object

java.lang.Thread

freemind.common.FreeMindTask

All Implemented Interfaces:

java.lang.Runnable

public abstract class FreeMindTask
extends java.lang.Thread

Long running tasks inside FreeMind should derive from this class.

Author:

foltin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FreeMindTask.ProgressDescription

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 FreeMindTask.ProgressDescription	mProgressDescription

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
FreeMindTask(javax.swing.RootPaneContainer pRootPaneContainer, int pAmountOfSteps, java.lang.String pName)

Method Summary

Modifier and Type	Method and Description
int	getAmountOfSteps()
int	getRounds()
boolean	isFinished()
boolean	isInterrupted()
protected abstract boolean	processAction() Subclasses should process one single action out of the set of its actions and then return.
void	run()
void	setAmountOfSteps(int pAmountOfSteps)
void	setFinished(boolean pFinished)
void	setInterrupted(boolean pInterrupted)

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

Field Detail

mProgressDescription

protected FreeMindTask.ProgressDescription mProgressDescription

Constructor Detail

FreeMindTask

public FreeMindTask(javax.swing.RootPaneContainer pRootPaneContainer,
                    int pAmountOfSteps,
                    java.lang.String pName)

Method Detail

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

processAction

protected abstract boolean processAction()
                                  throws java.lang.Exception

Subclasses should process one single action out of the set of its actions and then return. The method is directly called again by the task controller until it returns false.

Returns:

true, if further actions follow. False, if done.

Throws:

java.lang.Exception

isInterrupted

public boolean isInterrupted()

Overrides:

isInterrupted in class java.lang.Thread

setInterrupted

public void setInterrupted(boolean pInterrupted)

isFinished

public boolean isFinished()

setFinished

public void setFinished(boolean pFinished)

getAmountOfSteps

public int getAmountOfSteps()

setAmountOfSteps

public void setAmountOfSteps(int pAmountOfSteps)

getRounds

public int getRounds()