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 interface ProgressWorker.Builder<T,V>

Builds a ProgressWorker instance.

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>	maximumProgress(int maximumProgress)	Overrides any maximumProgress specified by the task itself.
ProgressWorker.Builder<T,V>	onCancelled(Runnable onCancelled)	Called in case the background task is cancelled via SwingWorker.cancel(boolean) or if it throws a CancelException
ProgressWorker.Builder<T,V>	onDone(Runnable onDone)
ProgressWorker.Builder<T,V>	onException(Consumer<Exception> onException)
ProgressWorker.Builder<T,V>	onInterrupted(Runnable onInterrupted)
ProgressWorker.Builder<T,V>	onProgress(Consumer<Integer> onProgress)
ProgressWorker.Builder<T,V>	onPublish(Consumer<List<V>> onPublish)
ProgressWorker.Builder<T,V>	onResult(Runnable onResult)
ProgressWorker.Builder<T,V>	onResult(Consumer<T> onResult)
ProgressWorker.Builder<T,V>	onStarted(Runnable onStarted)	Note that this handler does not get called in case the background task finishes before the SwingWorker.StateValue.STARTED change event is fired.

Method Details

maximumProgress

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

Overrides any maximumProgress specified by the task itself.

Parameters:

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

Returns:

this builder instance

See Also:

• ProgressWorker.ProgressTask.maximumProgress()
• ProgressWorker.ProgressResultTask.maximumProgress()

onStarted

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

Note that this handler does not get called in case the background task finishes before the SwingWorker.StateValue.STARTED change event is fired.

Parameters:

onStarted - called on the EDT before background processing is started

Returns:

this builder instance

onDone

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

Parameters:

onDone - called on the Event Dispatch Thread when the task is done running, successfully or not, before the result is processed

Returns:

this builder instance

onResult

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

Parameters:

onResult - called on the Event Dispatch Thread when the result of a successful run is available

Returns:

this builder instance

onResult

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

Parameters:

onResult - called on the Event Dispatch Thread when the result of a successful run is available

Returns:

this builder instance

onProgress

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

Parameters:

onProgress - called on the Event Dispatch Thread when progress is reported

Returns:

this builder instance

onPublish

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

Parameters:

onPublish - called on the Event Dispatch Thread when chunks are available for publishing

Returns:

this builder instance

onException

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

Parameters:

onException - called on the Event Dispatch Thread if an exception occurred

Returns:

this builder instance

onCancelled

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

Called in case the background task is cancelled via SwingWorker.cancel(boolean) or if it throws a CancelException

Parameters:

onCancelled - called on the Event Dispatch Thread if the background task was cancelled

Returns:

this builder instance

onInterrupted

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

Parameters:

onInterrupted - called on the Event Dispatch Thread if the background task was interrupted

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