Module is.codion.swing.common.model

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

Interface ProgressWorker.Builder<T,V>

Type Parameters:

T - the worker result type

V - the intermediate result type

Enclosing class:

ProgressWorker<T,V>

public static sealed interface ProgressWorker.Builder<T,V>

Builds a ProgressWorker instance.

Each handler method can be called multiple times to add multiple handlers. All handlers are called in the order they were added. When using a task that implements a handler interface (e.g. ProgressWorker.TaskHandler), those handler methods are added first, and any handlers added via this builder are called after.

Method Summary

Modifier and Type	Method	Description
ProgressWorker<T,V>	build()
ProgressWorker<T,V>	execute()	Builds and executes a new ProgressWorker based on this builder
ProgressWorker.Builder<T,V>	maximum(int maximum)	Overrides any maximum progress specified by the task itself.
ProgressWorker.Builder<T,V>	onCancelled(Runnable onCancelled)	Adds a handler called on the Event Dispatch Thread if the background task is cancelled via SwingWorker.cancel(boolean) or if it throws a CancelException.
ProgressWorker.Builder<T,V>	onDone(Runnable onDone)	Adds a handler called on the Event Dispatch Thread when the task is done running, successfully or not, before the result is processed.
ProgressWorker.Builder<T,V>	onException(Consumer<Exception> onException)	Adds a handler called on the Event Dispatch Thread if an exception occurred.
ProgressWorker.Builder<T,V>	onInterrupted(Runnable onInterrupted)	Adds a handler called on the Event Dispatch Thread if the background task was interrupted.
ProgressWorker.Builder<T,V>	onProgress(Consumer<Integer> onProgress)	Adds a handler called on the Event Dispatch Thread when progress is reported.
ProgressWorker.Builder<T,V>	onPublish(Consumer<List<V>> onPublish)	Adds a handler called on the Event Dispatch Thread when chunks are available for publishing.
ProgressWorker.Builder<T,V>	onResult(Consumer<T> onResult)	Adds a handler called on the Event Dispatch Thread when the result of a successful run is available, after any onSuccess(Runnable) handlers.
ProgressWorker.Builder<T,V>	onStarted(Runnable onStarted)	Adds a handler called on the EDT before background processing is started.
ProgressWorker.Builder<T,V>	onSuccess(Runnable onSuccess)	Adds a handler called on the Event Dispatch Thread after a successful task run, before any onResult(Consumer) handlers.

Method Details

maximum

ProgressWorker.Builder<T,V> maximum(int maximum)

Overrides any maximum progress specified by the task itself.

Parameters:

maximum - the maximum progress, ProgressWorker.DEFAULT_MAXIMUM (100) by default

Returns:

this builder instance

See Also:

• ProgressWorker.ProgressTask.maximum()
• ProgressWorker.ProgressResultTask.maximum()

onStarted

ProgressWorker.Builder<T,V> onStarted(Runnable onStarted)

Adds a handler called on the EDT before background processing is started.

Parameters:

onStarted - the handler to add

Returns:

this builder instance

onDone

ProgressWorker.Builder<T,V> onDone(Runnable onDone)

Adds a handler called on the Event Dispatch Thread when the task is done running, successfully or not, before the result is processed.

Parameters:

onDone - the handler to add

Returns:

this builder instance

onSuccess

ProgressWorker.Builder<T,V> onSuccess(Runnable onSuccess)

Adds a handler called on the Event Dispatch Thread after a successful task run, before any onResult(Consumer) handlers.

Parameters:

onSuccess - the handler to add

Returns:

this builder instance

onResult

ProgressWorker.Builder<T,V> onResult(Consumer<T> onResult)

Adds a handler called on the Event Dispatch Thread when the result of a successful run is available, after any onSuccess(Runnable) handlers.

Parameters:

onResult - the handler to add

Returns:

this builder instance

onProgress

ProgressWorker.Builder<T,V> onProgress(Consumer<Integer> onProgress)

Adds a handler called on the Event Dispatch Thread when progress is reported.

Parameters:

onProgress - the handler to add

Returns:

this builder instance

onPublish

ProgressWorker.Builder<T,V> onPublish(Consumer<List<V>> onPublish)

Adds a handler called on the Event Dispatch Thread when chunks are available for publishing.

Parameters:

onPublish - the handler to add

Returns:

this builder instance

onException

ProgressWorker.Builder<T,V> onException(Consumer<Exception> onException)

Adds a handler called on the Event Dispatch Thread if an exception occurred.

Parameters:

onException - the handler to add

Returns:

this builder instance

onCancelled

ProgressWorker.Builder<T,V> onCancelled(Runnable onCancelled)

Adds a handler called on the Event Dispatch Thread if the background task is cancelled via SwingWorker.cancel(boolean) or if it throws a CancelException.

Parameters:

onCancelled - the handler to add

Returns:

this builder instance

onInterrupted

ProgressWorker.Builder<T,V> onInterrupted(Runnable onInterrupted)

Adds a handler called on the Event Dispatch Thread if the background task was interrupted.

Parameters:

onInterrupted - the handler to add

Returns:

this builder instance

execute

ProgressWorker<T,V> execute()

Builds and executes a new ProgressWorker based on this builder

Returns:

a ProgressWorker based on this builder

build

ProgressWorker<T,V> build()

Returns:

a ProgressWorker based on this builder