com.fathzer.soft.ajlib.swing.worker

Class Worker<T,V>

java.lang.Object

javax.swing.SwingWorker<T,V>

com.fathzer.soft.ajlib.swing.worker.Worker<T,V>

Type Parameters:

T - the result type returned by this SwingWorker's doInBackground and get methods

V - the type used for carrying out intermediate results by this SwingWorker's publish and process methods

All Implemented Interfaces:

Runnable, Future<T>, RunnableFuture<T>

public abstract class Worker<T,V>
extends SwingWorker<T,V>

A SwingWorker that defines phases that can have different lengths.
By default, a SwingWorker reports its progress with an integer between 0 and 100 (see method setProgress). This class allows you to define any length then report the progress without having to convert it to percentage.
Another enhancement is the Worker notifies all the threads waiting for him when it finished is processing. To perform that, we were obliged to override the doInBackground method of SwingWorker and made it final. Developers should see doProcessing method has the equivalent of the SwingWorker.doInBackground

Author:

Jean-Marc Astesana
License: LGPL v3

See Also:

reportProgress(int)

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.SwingWorker

SwingWorker.StateValue

Field Summary

Fields

Modifier and Type	Field and Description
static String	JOB_PHASE The job phase property name
static String	PHASE_LENGTH The phase length property name
static String	PROGRESS_PROPERTY_NAME The progress property name of the SwingWorker (Should have been defined in SwingWorker by Oracle ?)
static String	STATE_PROPERTY_NAME The state property name of the SwingWorker (Should have been defined in SwingWorker by Oracle ?)

Constructor Summary

Constructors

Constructor and Description
Worker() Constructor.

Method Summary

Modifier and Type	Method and Description
protected T	doInBackground() Overrides the SwingWorker doInBackground method to force the worker to notify all threads waiting on this object (by invoking this.wait()) when the processing is finished.
protected abstract T	doProcessing() Performs the task processing and gets its result.
String	getPhase() Gets the current phase's title.
int	getPhaseLength() Gets the current phase's length.
boolean	isFinished() Tests whether the doProcessing method has ended.
void	reportProgress(int progress) Sets the progress of the current phase.
protected void	setPhase(String phase, int phaseLength) Sets the phase.
protected void	setPhaseLength(int phaseLength) Sets the phase length.

Methods inherited from class javax.swing.SwingWorker

addPropertyChangeListener, cancel, done, execute, firePropertyChange, get, get, getProgress, getPropertyChangeSupport, getState, isCancelled, isDone, process, publish, removePropertyChangeListener, run, setProgress

Methods inherited from class java.lang.Object

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

Field Detail

STATE_PROPERTY_NAME

public static final String STATE_PROPERTY_NAME

The state property name of the SwingWorker (Should have been defined in SwingWorker by Oracle ?)

See Also:

Constant Field Values

PROGRESS_PROPERTY_NAME

public static final String PROGRESS_PROPERTY_NAME

The progress property name of the SwingWorker (Should have been defined in SwingWorker by Oracle ?)

See Also:

Constant Field Values

JOB_PHASE

public static final String JOB_PHASE

The job phase property name

See Also:

Constant Field Values

PHASE_LENGTH

public static final String PHASE_LENGTH

The phase length property name

See Also:

Constant Field Values

Constructor Detail

Worker

public Worker()

Constructor.
The phase is initialize to null and the length is set to -1 (indeterminate length).

Method Detail

setPhase

protected void setPhase(String phase,
                        int phaseLength)

Sets the phase.

Parameters:

phase - The phase title

phaseLength - The phase length (a negative number means the length is indeterminate).

setPhaseLength

protected void setPhaseLength(int phaseLength)

Sets the phase length.

Parameters:

phaseLength - The phase length (a negative number means the length is indeterminate)

getPhase

public String getPhase()

Gets the current phase's title.

Returns:

a String or null if the phase was not set.

getPhaseLength

public int getPhaseLength()

Gets the current phase's length.

Returns:

an integer (negative if the phase length is indeterminate).

reportProgress

public void reportProgress(int progress)

Sets the progress of the current phase.
You should use this method instead of the super class setProgress method.

Parameters:

progress - The current progress

See Also:

setPhaseLength(int)

doInBackground

protected final T doInBackground()
                          throws Exception

Overrides the SwingWorker doInBackground method to force the worker to notify all threads waiting on this object (by invoking this.wait()) when the processing is finished.

Specified by:

doInBackground in class SwingWorker<T,V>

Throws:

Exception

doProcessing

protected abstract T doProcessing()
                           throws Exception

Performs the task processing and gets its result.
This method is called by the doInBackground method.

Returns:

The task result

Throws:

Exception - if a error occurs.

isFinished

public boolean isFinished()

Tests whether the doProcessing method has ended.
This method should be preferred to isDone when testing if the task is done after being awake from a this.wait() method, because it is guaranteed that this method returns true after the waiting object is awaked (isDone may still returns false, depending on the threads dispatching).

Returns:

true if the method ended, false if it is still running.