Module is.codion.swing.common.model

Package is.codion.swing.common.model.worker

Class ProgressWorker<T,V>

java.lang.Object

javax.swing.SwingWorker<T,V>

is.codion.swing.common.model.worker.ProgressWorker<T,V>

Type Parameters:

T - the type of result this ProgressWorker produces.

V - the type of intermediate result produced by this ProgressWorker

All Implemented Interfaces:

Runnable, Future<T>, RunnableFuture<T>

public final class ProgressWorker<T,V>
extends SwingWorker<T,V>

A SwingWorker implementation. Instances of this class are not reusable.

Note that this implementation does NOT coalesce progress reports or intermediate result publishing, but simply pushes those directly to the onProgress and onPublish handlers on the Event Dispatch Thread.

The onStarted handlers are guaranteed to be called on the Event Dispatch Thread before the background task executes, and the onDone handlers are guaranteed to be called after the background task completes.

All handler types support multiple handlers, which are called in the order they were added.

There are two ways to use this class:

• Builder-only: pass a task and wire handlers via the builder.
• Handler interfaces: implement one of the handler interfaces (ProgressWorker.TaskHandler, ProgressWorker.ResultTaskHandler, ProgressWorker.ProgressTaskHandler, ProgressWorker.ProgressResultTaskHandler) to encapsulate both the background task and its handlers in a single class. Handler interface methods are wired automatically and called first. Additional handlers can then be added via the builder and are called after.

On successful completion, handlers are called in this order: onDone → onSuccess → onResult(T) (result-producing tasks only).

Builder based usage example:

 ProgressWorker.builder(this::performTask)
   .onStarted(this::displayDialog)
   .onDone(this::closeDialog)
   .onSuccess(this::handleSuccess)
   .onResult(this::handleResult)
   .onProgress(this::displayProgress)
   .onPublish(this::publishMessage)
   .onCancelled(this::displayCancelledMessage)
   .onException(this::displayException)
   .execute();

See Also:

• builder()
• ProgressWorker.Handler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ProgressWorker.Builder<T,V>	Builds a ProgressWorker instance.
static interface	ProgressWorker.BuilderFactory	Provides builders for a given task type.
static interface	ProgressWorker.Handler	Provides default handler methods for the ProgressWorker lifecycle.
static interface	ProgressWorker.ProgressHandler<V>	Extends ProgressWorker.Handler with progress and publish handlers.
static interface	ProgressWorker.ProgressReporter<V>	Reports progress and publishes intermediate results for a ProgressWorker
static interface	ProgressWorker.ProgressResultTask<T,V>	A progress aware background task producing a result.
static interface	ProgressWorker.ProgressResultTaskHandler<T,V>	A ProgressWorker.ProgressResultTask combined with ProgressWorker.ProgressHandler, for encapsulating a progress-aware, result-producing background task and its handlers in a single class.
static interface	ProgressWorker.ProgressTask<V>	A progress aware background task.
static interface	ProgressWorker.ProgressTaskHandler<V>	A ProgressWorker.ProgressTask combined with ProgressWorker.ProgressHandler, for encapsulating a progress-aware background task and its handlers in a single class.
static interface	ProgressWorker.ResultTask<T>	A background task producing a result.
static interface	ProgressWorker.ResultTaskHandler<T>	A ProgressWorker.ResultTask combined with ProgressWorker.Handler, for encapsulating a result-producing background task and its handlers in a single class.
static interface	ProgressWorker.Task	A background task.
static interface	ProgressWorker.TaskHandler	A ProgressWorker.Task combined with ProgressWorker.Handler, for encapsulating a background task and its handlers in a single class.

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

SwingWorker.StateValue

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_MAXIMUM

Method Summary

Modifier and Type	Method	Description
static ProgressWorker.BuilderFactory	builder()
protected @Nullable T	doInBackground()
protected void	done()

Methods inherited from class javax.swing.SwingWorker

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

Methods inherited from interface java.util.concurrent.Future

exceptionNow, resultNow, state

Field Details

DEFAULT_MAXIMUM

public static final int DEFAULT_MAXIMUM

See Also:

• Constant Field Values

Method Details

builder

public static ProgressWorker.BuilderFactory builder()

Returns:

a ProgressWorker.BuilderFactory

doInBackground

protected @Nullable T doInBackground()
                              throws Exception

Specified by:

doInBackground in class SwingWorker<T,V>

Throws:

Exception

done

protected void done()

Overrides:

done in class SwingWorker<T,V>