io.datafx.core.concurrent

Class DataFxTask<V>

java.lang.Object

java.util.concurrent.FutureTask<V>

javafx.concurrent.Task<V>

io.datafx.core.concurrent.DataFxTask<V>

Type Parameters:

V - the result type of method getValue

All Implemented Interfaces:

TaskStateHandler, java.lang.Runnable, java.util.concurrent.Future<V>, java.util.concurrent.RunnableFuture<V>, javafx.concurrent.Worker<V>, javafx.event.EventTarget

Direct Known Subclasses:

CallableBasedDataFxTask, RunnableBasedDataFxTask

public abstract class DataFxTask<V>
extends javafx.concurrent.Task<V>
implements TaskStateHandler

A special task that provides some additional features.

Property Summary

Type	Property and Description
javafx.beans.property.BooleanProperty	cancelable Indicates that the task is currently cancelable.

Properties inherited from class javafx.concurrent.Task

exceptionProperty, messageProperty, onCancelledProperty, onFailedProperty, onRunningProperty, onScheduledProperty, onSucceededProperty, progressProperty, runningProperty, stateProperty, titleProperty, totalWorkProperty, valueProperty, workDoneProperty

Nested Class Summary

Nested classes/interfaces inherited from interface javafx.concurrent.Worker

javafx.concurrent.Worker.State

Constructor Summary

Constructors

Constructor and Description
DataFxTask()

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning)
javafx.beans.property.BooleanProperty	cancelableProperty() Indicates that the task is currently cancelable.
boolean	isCancelable() Checks if the task is cancelable
void	setCancelable(boolean cancelable) Sets the value of the property cancelable.
void	then(java.util.function.Consumer<V> consumer)
void	updateTaskMessage(java.lang.String message) Updates the message of the handled task
void	updateTaskProgress(double workDone, double max)
void	updateTaskProgress(long workDone, long max)
void	updateTaskTitle(java.lang.String title) Alters the title of the handled task

Methods inherited from class javafx.concurrent.Task

addEventFilter, addEventHandler, buildEventDispatchChain, call, cancel, cancelled, exceptionProperty, failed, fireEvent, getException, getMessage, getOnCancelled, getOnFailed, getOnRunning, getOnScheduled, getOnSucceeded, getProgress, getState, getTitle, getTotalWork, getValue, getWorkDone, isRunning, messageProperty, onCancelledProperty, onFailedProperty, onRunningProperty, onScheduledProperty, onSucceededProperty, progressProperty, removeEventFilter, removeEventHandler, running, runningProperty, scheduled, setEventHandler, setOnCancelled, setOnFailed, setOnRunning, setOnScheduled, setOnSucceeded, stateProperty, succeeded, titleProperty, totalWorkProperty, updateMessage, updateProgress, updateProgress, updateTitle, updateValue, valueProperty, workDoneProperty

Methods inherited from class java.util.concurrent.FutureTask

done, get, get, isCancelled, isDone, run, runAndReset, set, setException

Methods inherited from class java.lang.Object

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

Property Detail

cancelable

public javafx.beans.property.BooleanProperty cancelableProperty

Indicates that the task is currently cancelable.

See Also:

isCancelable(), setCancelable(boolean)

Constructor Detail

DataFxTask

public DataFxTask()

Method Detail

updateTaskTitle

public void updateTaskTitle(java.lang.String title)

Description copied from interface: TaskStateHandler

Alters the title of the handled task

Specified by:

updateTaskTitle in interface TaskStateHandler

Parameters:

title - the new title

updateTaskMessage

public void updateTaskMessage(java.lang.String message)

Description copied from interface: TaskStateHandler

Updates the message of the handled task

Specified by:

updateTaskMessage in interface TaskStateHandler

Parameters:

message - the new message

updateTaskProgress

public void updateTaskProgress(double workDone,
                               double max)

Specified by:

updateTaskProgress in interface TaskStateHandler

updateTaskProgress

public void updateTaskProgress(long workDone,
                               long max)

Specified by:

updateTaskProgress in interface TaskStateHandler

cancelableProperty

public javafx.beans.property.BooleanProperty cancelableProperty()

Indicates that the task is currently cancelable.

See Also:

isCancelable(), setCancelable(boolean)

isCancelable

public boolean isCancelable()

Checks if the task is cancelable

Returns:

true if the task is currently cancelable

setCancelable

public void setCancelable(boolean cancelable)

Sets the value of the property cancelable.

Specified by:

setCancelable in interface TaskStateHandler

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface java.util.concurrent.Future<V>

Overrides:

cancel in class javafx.concurrent.Task<V>

then

public void then(java.util.function.Consumer<V> consumer)