This class is essentially a wrapper around Task. We cannot use Task directly since it runs certain update notifications on the JavaFX thread, and so makes testing harder. We take the opportunity and implement a fluid interface.

A task created here is to be submitted to org.jabref.gui.Globals#TASK_EXECUTOR: Use TaskExecutor#execute(BackgroundTask) to submit.

Example (for using the fluent interface)

BackgroundTask
    .wrap(() -> ...)
    .showToUser(true)
    .onRunning(() -> ...)
    .onSuccess(() -> ...)
    .onFailure(() -> ...)
    .executeWith(taskExecutor);

Background: The task executor one takes care to show it in the UI. See org.jabref.gui.StateManager#addBackgroundTask(BackgroundTask, Task) for details.

Todo

Think of migrating to RxJava; CompletableFuture do not seem to support everything. If this is not possible, add an @implNote why.

Nested and Inner Type Summary

Modifier and Type	Class and Description
protected static record	BackgroundTask.BackgroundProgress

Modifier and Type	Field and Description
public static ImmutableMap<String, Node>	iconMap
private final BooleanProperty	isCanceled
private static final Logger	LOGGER
private final StringProperty	message
private Consumer<Exception>	onException
private Runnable	onFinished
private Runnable	onRunning
private Consumer<V>	onSuccess
private final ObjectProperty<BackgroundTask.BackgroundProgress>	progress
private final BooleanProperty	showToUser
private final StringProperty	title
private final BooleanProperty	willBeRecoveredAutomatically
private final DoubleProperty	workDonePercentage

Access	Constructor and Description
public	BackgroundTask()

Method Summary

Modifier and Type	Method and Description
protected abstract V	call()
public void	cancel()
private static <T> Consumer<T>	chain(Runnable first, Consumer<T> second)
public Future<?>	executeWith(TaskExecutor taskExecutor)
public static Node	getIcon(Task<?> task)
pack-priv Consumer<Exception>	getOnException()
pack-priv Runnable	getOnRunning()
pack-priv Consumer<V>	getOnSuccess()
protected BackgroundTask.BackgroundProgress	getProgress()
public double	getWorkDonePercentage()
public boolean	isCanceled()
public BooleanProperty	isCanceledProperty()
public StringProperty	messageProperty()
public BackgroundTask<V>	onFailure(Consumer<Exception> onException) Sets the `Consumer` that is invoked after the task has failed with an exception.
public BackgroundTask<V>	onFinished(Runnable onFinished) Sets the `Runnable` that is invoked after the task is finished, irrespectively if it was successful or failed with an error.
public BackgroundTask<V>	onRunning(Runnable onRunning) Sets the `Runnable` that is invoked after the task is started.
public BackgroundTask<V>	onSuccess(Consumer<V> onSuccess) Sets the `Consumer` that is invoked after the task is successfully finished.
protected ObjectProperty<BackgroundTask.BackgroundProgress>	progressProperty()
public Future<?>	scheduleWith(TaskExecutor taskExecutor, long delay, TimeUnit unit)
public boolean	showToUser()
public BackgroundTask<V>	showToUser(boolean show)
public < type of the return value of the second task T> BackgroundTask<T>	then(Function<V, BackgroundTask<T>> the function that creates the new task nextTaskFactory) Creates a `BackgroundTask` that first runs this task and based on the result runs a second task.
public < type of the return value of the second task T> BackgroundTask<T>	thenRun(Function<V, T> the function that performs the next operation nextOperation) Creates a `BackgroundTask` that first runs this task and based on the result runs a second task.
public BackgroundTask<Void>	thenRun(Consumer<V> the function that performs the next operation nextOperation) Creates a `BackgroundTask` that first runs this task and based on the result runs a second task.
public StringProperty	titleProperty()
public void	updateMessage(String newMessage)
protected void	updateProgress(BackgroundTask.BackgroundProgress newProgress)
protected void	updateProgress(double workDone, double max)
public boolean	willBeRecoveredAutomatically()
public void	willBeRecoveredAutomatically(boolean willBeRecoveredAutomatically)
public BackgroundTask<V>	withInitialMessage(String message)
public DoubleProperty	workDonePercentageProperty()
public static <V> BackgroundTask<V>	wrap(Callable<V> callable)
public static BackgroundTask<Void>	wrap(Runnable runnable)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

iconMap	back to summary
public static ImmutableMap<String, Node> iconMap

isCanceled	back to summary
private final BooleanProperty isCanceled

LOGGER	back to summary
private static final Logger LOGGER

message	back to summary
private final StringProperty message

onException	back to summary
private Consumer<Exception> onException

onFinished	back to summary
private Runnable onFinished

onRunning	back to summary
private Runnable onRunning

onSuccess	back to summary
private Consumer<V> onSuccess

progress	back to summary
private final ObjectProperty<BackgroundTask.BackgroundProgress> progress

showToUser	back to summary
private final BooleanProperty showToUser

title	back to summary
private final StringProperty title

willBeRecoveredAutomatically	back to summary
private final BooleanProperty willBeRecoveredAutomatically

workDonePercentage	back to summary
private final DoubleProperty workDonePercentage

BackgroundTask	back to summary
public BackgroundTask()

Method Detail

call	back to summary
protected abstract V call() throws Exception

cancel	back to summary
public void cancel()

chain	back to summary
private static <T> Consumer<T> chain(Runnable first, Consumer<T> second)

executeWith	back to summary
public Future<?> executeWith(TaskExecutor taskExecutor)

getIcon	back to summary
public static Node getIcon(Task<?> task)

getOnException	back to summary
pack-priv Consumer<Exception> getOnException()

getOnRunning	back to summary
pack-priv Runnable getOnRunning()

getOnSuccess	back to summary
pack-priv Consumer<V> getOnSuccess()

getProgress	back to summary
protected BackgroundTask.BackgroundProgress getProgress()

getWorkDonePercentage	back to summary
public double getWorkDonePercentage()

isCanceled	back to summary
public boolean isCanceled()

isCanceledProperty	back to summary
public BooleanProperty isCanceledProperty()

messageProperty	back to summary
public StringProperty messageProperty()

onFailure	back to summary
public BackgroundTask<V> onFailure(Consumer<Exception> onException) Sets the `Consumer` that is invoked after the task has failed with an exception. The consumer always runs on the JavaFX thread.

onFinished	back to summary
public BackgroundTask<V> onFinished(Runnable onFinished) Sets the `Runnable` that is invoked after the task is finished, irrespectively if it was successful or failed with an error.

onRunning	back to summary
public BackgroundTask<V> onRunning(Runnable onRunning) Sets the `Runnable` that is invoked after the task is started.

onSuccess	back to summary
public BackgroundTask<V> onSuccess(Consumer<V> onSuccess) Sets the `Consumer` that is invoked after the task is successfully finished. The consumer always runs on the JavaFX thread.

progressProperty	back to summary
protected ObjectProperty<BackgroundTask.BackgroundProgress> progressProperty()

scheduleWith	back to summary
public Future<?> scheduleWith(TaskExecutor taskExecutor, long delay, TimeUnit unit)

showToUser	back to summary
public boolean showToUser()

showToUser	back to summary
public BackgroundTask<V> showToUser(boolean show)

then back to summary

then	back to summary
public <T> BackgroundTask<T> then(Function<V, BackgroundTask<T>> nextTaskFactory) Creates a `BackgroundTask` that first runs this task and based on the result runs a second task. Parameters <T> type of the return value of the second task nextTaskFactory:Function<V, BackgroundTask<T>> the function that creates the new task

public <T> BackgroundTask<T> then(Function<V, BackgroundTask<T>> nextTaskFactory)

Creates a BackgroundTask that first runs this task and based on the result runs a second task.

Parameters

<T>: type of the return value of the second task
nextTaskFactory:Function<V, BackgroundTask<T>>: the function that creates the new task

thenRun back to summary

thenRun	back to summary
public <T> BackgroundTask<T> thenRun(Function<V, T> nextOperation) Creates a `BackgroundTask` that first runs this task and based on the result runs a second task. Parameters <T> type of the return value of the second task nextOperation:Function<V, T> the function that performs the next operation

public <T> BackgroundTask<T> thenRun(Function<V, T> nextOperation)

Creates a BackgroundTask that first runs this task and based on the result runs a second task.

Parameters

<T>: type of the return value of the second task
nextOperation:Function<V, T>: the function that performs the next operation

thenRun back to summary

thenRun	back to summary
public BackgroundTask<Void> thenRun(Consumer<V> nextOperation) Creates a `BackgroundTask` that first runs this task and based on the result runs a second task. Parameters nextOperation:Consumer<V> the function that performs the next operation

public BackgroundTask<Void> thenRun(Consumer<V> nextOperation)

Creates a BackgroundTask that first runs this task and based on the result runs a second task.

Parameters

nextOperation:Consumer<V>: the function that performs the next operation

titleProperty	back to summary
public StringProperty titleProperty()

updateMessage	back to summary
public void updateMessage(String newMessage)

updateProgress	back to summary
protected void updateProgress(BackgroundTask.BackgroundProgress newProgress)

updateProgress	back to summary
protected void updateProgress(double workDone, double max)

willBeRecoveredAutomatically	back to summary
public boolean willBeRecoveredAutomatically()

willBeRecoveredAutomatically	back to summary
public void willBeRecoveredAutomatically(boolean willBeRecoveredAutomatically)

withInitialMessage	back to summary
public BackgroundTask<V> withInitialMessage(String message)

workDonePercentageProperty	back to summary
public DoubleProperty workDonePercentageProperty()

wrap	back to summary
public static <V> BackgroundTask<V> wrap(Callable<V> callable)

wrap	back to summary
public static BackgroundTask<Void> wrap(Runnable runnable)

org.jabref.gui.util back to summary

protected final Record BackgroundTask.BackgroundProgress

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.gui.util.BackgroundTask.BackgroundProgress

Record Components

workDone:double
max:double

Field Summary

Modifier and Type	Field and Description
private final double	max Record Component accessed by max().
private final double	workDone Record Component accessed by workDone().

Constructor Summary

Access	Constructor and Description
protected	BackgroundProgress(double workDone, double max)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object the reference object with which to compare. o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public double	getWorkDonePercentage()
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public double	max() Record Component getter of max.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public double	workDone() Record Component getter of workDone.

Field Detail

max	back to summary
private final double max Record Component accessed by max().

workDone	back to summary
private final double workDone Record Component accessed by workDone().

Constructor Detail

BackgroundProgress	back to summary
protected BackgroundProgress(double workDone, double max)

Method Detail

equals back to summary

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

getWorkDonePercentage	back to summary
public double getWorkDonePercentage()

hashCode back to summary

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Returns:int: a hash code value for this record.

max	back to summary
public double max() Record Component getter of max.

toString back to summary

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Returns:String: a string representation of the object.

workDone	back to summary
public double workDone() Record Component getter of workDone.

public abstract Class BackgroundTask<V>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected final Record BackgroundTask.BackgroundProgress

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail