Module eu.steffo.cleaver

Package eu.steffo.cleaver.logic.job

Class Job

java.lang.Object

java.lang.Thread

eu.steffo.cleaver.logic.job.Job

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

ChopJob, StitchJob

public abstract class Job
extends Thread

A task that can be executed by Cleaver in a separate Thread, and that keeps track of its progress and can display progress updates on a Swing GUI.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field	Description
private Runnable	onProgressChange	A Runnable that will be invoked on the GUI Thread (with SwingUtilities.invokeLater(Runnable)) every time setProgress(Progress) is called.
private Progress	progress	The current Progress of the job.

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor	Description
Job()	Construct a Job and set its progress to Not started.
Job(Runnable onProgressChange)	Construct a Job, set its progress to Not started and set the Runnable that will be called on the GUI Thread every time the progress changes.

Method Summary

Modifier and Type	Method	Description
abstract String	getFileString()
abstract String	getOperationsString()
Progress	getProgress()
String	getProgressString()
abstract String	getTypeString()
abstract void	run()
protected void	setProgress(Progress progress)	Set the progress of the job to a different value.

Methods inherited from class java.lang.Thread

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

Methods inherited from class java.lang.Object

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

Field Details

progress

private Progress progress

The current Progress of the job.

See Also:

NotStartedProgress, WorkingProgress, FinishedProgress, ErrorProgress

onProgressChange

private Runnable onProgressChange

A Runnable that will be invoked on the GUI Thread (with SwingUtilities.invokeLater(Runnable)) every time setProgress(Progress) is called.

Constructor Details

Job

public Job()

Construct a Job and set its progress to Not started.

Job

public Job(Runnable onProgressChange)

Construct a Job, set its progress to Not started and set the Runnable that will be called on the GUI Thread every time the progress changes.

Parameters:

onProgressChange - A Runnable that will be invoked on the GUI Thread (with SwingUtilities.invokeLater(Runnable)) every time setProgress(Progress) is called.

Method Details

getProgress

public Progress getProgress()

Returns:

The current Progress of the job.

See Also:

NotStartedProgress, WorkingProgress, FinishedProgress, ErrorProgress

setProgress

protected void setProgress(Progress progress)

Set the progress of the job to a different value. If onProgressChange is set, schedule its invocation after the set, allowing for example the updating of a TableModel after the progress change.

Parameters:

progress - The value progress should be set to.

getTypeString

public abstract String getTypeString()

Returns:

The String that should be displayed in the Type column of the Jobs Table.

getFileString

public abstract String getFileString()

Returns:

The String that should be displayed in the File column of the Jobs Table.

getOperationsString

public abstract String getOperationsString()

Returns:

The String that should be displayed in the Operations column of the Jobs Table.

getProgressString

public String getProgressString()

Returns:

The String that should be displayed in the Progress column of the Jobs Table.

run

public abstract void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread