de.javagl.swing.tasks.executors

Class GenericProgressTask<T>

java.lang.Object

de.javagl.swing.tasks.executors.GenericProgressTask<T>

Type Parameters:

T - The return type

All Implemented Interfaces:

ProgressTask, Callable<T>

public final class GenericProgressTask<T>
extends Object
implements Callable<T>, ProgressTask

Implementation of a ProgressTask that also implements the Callable interface, and delegates its work to another Callable.

Constructor Summary

Constructors

Constructor and Description
GenericProgressTask(String description) Creates a new task with the given description.

Method Summary

Modifier and Type	Method and Description
void	addProgressListener(ProgressListener progressListener) Add the given ProgressListener to be informed about changes in this task.
T	call()
String	getDescription() Returns the description of this task.
ProgressListener	getDispatchingProgressListener() Returns a ProgressListener that may be informed about changes in the progress of the callable that was given to this task.
void	removeProgressListener(ProgressListener progressListener) Remove the given ProgressListener to no longer be informed about changes in this task.
void	setCallable(Callable<T> callable) Set the callable that should be executed by this task
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericProgressTask

public GenericProgressTask(String description)

Creates a new task with the given description. The description should be a short string that is suitable for using it as a label for this task, in a UI. The callable that should be executed by this task can be set with setCallable(Callable). If no callable is set, then this task simply returns null.

Parameters:

description - The description

Method Detail

setCallable

public void setCallable(Callable<T> callable)

Set the callable that should be executed by this task

Parameters:

callable - The callable

getDispatchingProgressListener

public ProgressListener getDispatchingProgressListener()

Returns a ProgressListener that may be informed about changes in the progress of the callable that was given to this task. It will forward all progress changes to the ProgressListeners that have been registered for this task.

Returns:

The dispatching ProgressListener

call

public T call()
       throws Exception

Specified by:

call in interface Callable<T>

Throws:

Exception

getDescription

public String getDescription()

Description copied from interface: ProgressTask

Returns the description of this task. This should be a short, human-readable string that is suitable for being displayed in a label in a UI.

Specified by:

getDescription in interface ProgressTask

Returns:

The description

addProgressListener

public void addProgressListener(ProgressListener progressListener)

Description copied from interface: ProgressTask

Add the given ProgressListener to be informed about changes in this task.

Specified by:

addProgressListener in interface ProgressTask

Parameters:

progressListener - The ProgressListener to add

removeProgressListener

public void removeProgressListener(ProgressListener progressListener)

Description copied from interface: ProgressTask

Remove the given ProgressListener to no longer be informed about changes in this task.

Specified by:

removeProgressListener in interface ProgressTask

Parameters:

progressListener - The ProgressListener to remove

toString

public String toString()

Overrides:

toString in class Object