Package PamUtils.worker

Class PamWorker<T>

java.lang.Object

PamUtils.worker.PamWorker<T>

public class PamWorker<T>
extends Object

Wrapper around a SwingWorker so it's easy to launch a background thread that will update a modal dialog with a progress bar and some text

Author:

Doug Gillespie

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	PamWorker.BackgroundWorker

Constructor Summary

Constructors

Constructor	Description
PamWorker(PamWorkWrapper<T> pamWorkWrapper)	Create a PamWorker without a swing dialog.
PamWorker(PamWorkWrapper<T> pamWorkWrapper, Window parentFrame, int nTextRows, String title)

Method Summary

Modifier and Type	Method	Description
PamWorker<T>.BackgroundWorker	getBackgroundWorker()
PamWorkDialog	getPamWorkDialog()
PamWorkerProgressFX	getPamWorkProgress()	Get the PAM progress property.
Exception	getThrownException()	Get the exception if one was thrown in the worker thread.
boolean	isDumpException()	calls Exception.printStackTrace() if an excpetion is thrown in the worker thread.
void	setDumpException(boolean dumpException)	calls Exception.printStackTrace() if an exception is thrown in the worker thread.
boolean	start()	Start the worker thread.
void	update(PamWorkProgressMessage progressMessage)

Methods inherited from class java.lang.Object

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

Constructor Details

PamWorker

public PamWorker(PamWorkWrapper<T> pamWorkWrapper,
 Window parentFrame,
 int nTextRows,
 String title)

Parameters:

pamWorkWrapper - wrapper round callback and worker functions

parentFrame - parent frame of progress dialog

nTextRows - number of rows of text for progress messages

title - dialog title

PamWorker

public PamWorker(PamWorkWrapper<T> pamWorkWrapper)

Create a PamWorker without a swing dialog.

Parameters:

pamWorkWrapper - wrapper round callback and worker functions

parentFrame - parent frame of progress dialog

nTextRows - number of rows of text for progress messages

title - dialog title

Method Details

start

public boolean start()

Start the worker thread.

Returns:

true of the thread is started. flase if the thread is done, cancelled or running.

getPamWorkDialog

public PamWorkDialog getPamWorkDialog()

getBackgroundWorker

public PamWorker<T>.BackgroundWorker getBackgroundWorker()

update

public void update(PamWorkProgressMessage progressMessage)

getPamWorkProgress

public PamWorkerProgressFX getPamWorkProgress()

Get the PAM progress property.

Returns:

class with the progress properties of the worker.

isDumpException

public boolean isDumpException()

calls Exception.printStackTrace() if an excpetion is thrown in the worker thread.
Default is true.

Returns:

the dumpException

setDumpException

public void setDumpException(boolean dumpException)

calls Exception.printStackTrace() if an exception is thrown in the worker thread.
Default is true.

Parameters:

dumpException - the dumpException to set

getThrownException

public Exception getThrownException()

Get the exception if one was thrown in the worker thread.

Returns:

the thrownException