Package cz.masci.springfx.mvci.util.builder

Class BackgroundTaskBuilder<T>

java.lang.Object

cz.masci.springfx.mvci.util.builder.BackgroundTaskBuilder<T>

Type Parameters:

T - the type of the background task result

public class BackgroundTaskBuilder<T>
extends Object

This builder prepares Task with most events handlers.

Basic usage

   BackgroundTaskBuilder.task(() -> "Hello").start();
 

All event handlers

   BackgroundTaskBuilder
      .task(() -> "Hello")
      .onCancelled(task -> System.out.println("Task has been cancelled"))
      .onFailed(task -> System.out.println("Task failed with an error: " + task.getException()))
      .onRunning(task -> System.out.println("Task has been started"))
      .onScheduled(task -> System.out.println("Task has been scheduled"))
      .onSucceeded(taskResult -> System.out.println("Task ended with result: " + taskResult))
      .postGuiCall(() -> System.out.println("This part is running in JavaFX thread"))
      .start();
 

Post GUI Call

postGuiCall is called when Task succeeded, cancelled or failed after appropriate onXXX method is called.

Method Summary

Modifier and Type	Method	Description
javafx.concurrent.Task<T>	build()
BackgroundTaskBuilder<T>	onCancelled(Consumer<javafx.concurrent.Task<T>> onCancelled)
BackgroundTaskBuilder<T>	onFailed(Consumer<javafx.concurrent.Task<T>> onFailed)
BackgroundTaskBuilder<T>	onRunning(Consumer<javafx.concurrent.Task<T>> onRunning)
BackgroundTaskBuilder<T>	onScheduled(Consumer<javafx.concurrent.Task<T>> onScheduled)
BackgroundTaskBuilder<T>	onSucceeded(Consumer<T> onSucceeded)
BackgroundTaskBuilder<T>	postGuiCall(Runnable postGuiCall)
void	start()
static <T> BackgroundTaskBuilder<T>	task(Callable<T> callableTask)
static <T> BackgroundTaskBuilder<T>	task(org.apache.commons.lang3.function.FailableFunction<javafx.concurrent.Task<T>,T,? extends Exception> functionalTask)

Methods inherited from class java.lang.Object

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

Method Details

task

public static <T> BackgroundTaskBuilder<T> task(Callable<T> callableTask)

task

public static <T> BackgroundTaskBuilder<T> task(org.apache.commons.lang3.function.FailableFunction<javafx.concurrent.Task<T>,T,? extends Exception> functionalTask)

start

public void start()

build

public javafx.concurrent.Task<T> build()

postGuiCall

public BackgroundTaskBuilder<T> postGuiCall(Runnable postGuiCall)

onCancelled

public BackgroundTaskBuilder<T> onCancelled(Consumer<javafx.concurrent.Task<T>> onCancelled)

onFailed

public BackgroundTaskBuilder<T> onFailed(Consumer<javafx.concurrent.Task<T>> onFailed)

onRunning

public BackgroundTaskBuilder<T> onRunning(Consumer<javafx.concurrent.Task<T>> onRunning)

onScheduled

public BackgroundTaskBuilder<T> onScheduled(Consumer<javafx.concurrent.Task<T>> onScheduled)

onSucceeded

public BackgroundTaskBuilder<T> onSucceeded(Consumer<T> onSucceeded)