de.javagl.swing.tasks

Class SwingTaskExecutorBuilder<T>

java.lang.Object

de.javagl.swing.tasks.SwingTaskExecutorBuilder<T>

Type Parameters:

T - The result type of the SwingTask

public final class SwingTaskExecutorBuilder<T>
extends Object

A builder for SwingTaskExecutor instances, returned by SwingTaskExecutors.create(SwingTask). It allows setting all parameters for the execution of a SwingTask, in a fluent style, and finally obtaining the SwingTaskExecutor instance by calling build().

Method Summary

Modifier and Type	Method and Description
SwingTaskExecutor<T>	build() Build the SwingTaskExecutor based on the current configuration of this builder
SwingTaskExecutorBuilder<T>	setCancelable(boolean cancelable) Set whether the SwingTask should be cancelable, and the SwingTaskView should contain a button for canceling the task
SwingTaskExecutorBuilder<T>	setDialogUncaughtExceptionHandler() Set a handler for potential uncaught exceptions that happen during the execution of the SwingTask.
SwingTaskExecutorBuilder<T>	setMillisToDecideToPopup(int millisToDecideToPopup) Set the number of milliseconds that the Event Dispatch Thread should be blocked when calling SwingTaskExecutor.execute() before the decision is made about whether to show a SwingTaskView or not
SwingTaskExecutorBuilder<T>	setMillisToPopup(int millisToPopup) Set the number of milliseconds that the task has to take so that a SwingTaskView will be shown.
SwingTaskExecutorBuilder<T>	setModal(boolean modal) Set whether the SwingTaskView that may be shown should be modal
SwingTaskExecutorBuilder<T>	setParentComponent(Component parentComponent) Set the parent component for the SwingTaskView.
SwingTaskExecutorBuilder<T>	setParentWindow(Window parentWindow) Set the parent window for the SwingTaskView that may be shown.
SwingTaskExecutorBuilder<T>	setSwingTaskViewFactory(SwingTaskViewFactory swingTaskViewFactory) Set the factory that will be called to create the SwingTaskView that will be displayed while the task is running.
SwingTaskExecutorBuilder<T>	setTitle(String title) Set the title of the SwingTaskView that may be shown
SwingTaskExecutorBuilder<T>	setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler uncaughtExceptionHandler) Set the handler that should be assigned to the SwingTask in order to handle potential uncaught exceptions that happen during the execution

Methods inherited from class java.lang.Object

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

Method Detail

setParentWindow

public SwingTaskExecutorBuilder<T> setParentWindow(Window parentWindow)

Set the parent window for the SwingTaskView that may be shown. If this is not explicitly set, then the window ancestor of the parent component will be used. If no parent component was set, then the currently focused java.awt.Frame (or the first one that is visible) will be used. If the parent is explicitly set to null, then the SwingTaskView will have no parent.

Parameters:

parentWindow - The parent window.

Returns:

This builder

setParentComponent

public SwingTaskExecutorBuilder<T> setParentComponent(Component parentComponent)

Set the parent component for the SwingTaskView. If no parent window was explicitly set, then the window ancestor of the parent component will be used as the parent window of the SwingTaskView

Parameters:

parentComponent - The parent component for the SwingTaskView

Returns:

This builder

setTitle

public SwingTaskExecutorBuilder<T> setTitle(String title)

Set the title of the SwingTaskView that may be shown

Parameters:

title - The title of the SwingTaskView

Returns:

This builder

setModal

public SwingTaskExecutorBuilder<T> setModal(boolean modal)

Set whether the SwingTaskView that may be shown should be modal

Parameters:

modal - Whether the SwingTaskView should be modal

Returns:

This builder

setCancelable

public SwingTaskExecutorBuilder<T> setCancelable(boolean cancelable)

Set whether the SwingTask should be cancelable, and the SwingTaskView should contain a button for canceling the task

Parameters:

cancelable - Whether the SwingTask should be cancelable

Returns:

This builder

setMillisToDecideToPopup

public SwingTaskExecutorBuilder<T> setMillisToDecideToPopup(int millisToDecideToPopup)

Set the number of milliseconds that the Event Dispatch Thread should be blocked when calling SwingTaskExecutor.execute() before the decision is made about whether to show a SwingTaskView or not

Parameters:

millisToDecideToPopup - The number of milliseconds

Returns:

This builder

setMillisToPopup

public SwingTaskExecutorBuilder<T> setMillisToPopup(int millisToPopup)

Set the number of milliseconds that the task has to take so that a SwingTaskView will be shown. After the decision delay has passed, the completion time of the task will be predicted, based on the progress that has been reported by the task so far. If the completion time is greater than the time that is passed to this method, then a SwingTaskView will be shown. Also, when the task actually takes longer than the time that is passed to this method, a SwingTaskView will be shown.

Parameters:

millisToPopup - The number of milliseconds

Returns:

This builder

setUncaughtExceptionHandler

public SwingTaskExecutorBuilder<T> setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler uncaughtExceptionHandler)

Set the handler that should be assigned to the SwingTask in order to handle potential uncaught exceptions that happen during the execution

Parameters:

uncaughtExceptionHandler - The exception handler

Returns:

This builder

See Also:

setDialogUncaughtExceptionHandler()

setDialogUncaughtExceptionHandler

public SwingTaskExecutorBuilder<T> setDialogUncaughtExceptionHandler()

Set a handler for potential uncaught exceptions that happen during the execution of the SwingTask. This handler will show a dialog containing the exception stack trace.

Returns:

This builder

See Also:

#setUncaughtExceptionHandler(UncaughtExceptionHandler)

setSwingTaskViewFactory

public SwingTaskExecutorBuilder<T> setSwingTaskViewFactory(SwingTaskViewFactory swingTaskViewFactory)

Set the factory that will be called to create the SwingTaskView that will be displayed while the task is running.

Parameters:

swingTaskViewFactory - The SwingTaskViewFactory

Returns:

This builder

build

public SwingTaskExecutor<T> build()

Build the SwingTaskExecutor based on the current configuration of this builder

Returns:

The SwingTaskExecutor