io.datafx.core.concurrent.ConcurrentUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Show all versions of core Show documentation
Visualizing Enterprise Data in JavaFX
/**
* Copyright (c) 2011, 2014, Jonathan Giles, Johan Vos, Hendrik Ebbers
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of DataFX, the website javafxdata.org, nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL DataFX BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package io.datafx.core.concurrent;
import javafx.application.Platform;
import javafx.beans.binding.BooleanBinding;
import javafx.beans.property.BooleanProperty;
import javafx.beans.property.ReadOnlyBooleanProperty;
import javafx.beans.property.SimpleBooleanProperty;
import javafx.beans.value.ChangeListener;
import javafx.concurrent.Service;
import javafx.concurrent.Task;
import javafx.concurrent.Worker;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Executor;
import java.util.concurrent.FutureTask;
import java.util.concurrent.locks.Condition;
import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;
import java.util.function.Consumer;
/**
* Utility class for concurrency issues in JavaFX
*
* @author Hendrik Ebbers
*/
public class ConcurrentUtils {
private ConcurrentUtils() {
}
/**
* Runs the given Runnable on the JavaFX Application Thread. The method blocks until the Runnable is executed completely.
* You should use the {@link io.datafx.core.concurrent.ProcessChain} for concurrent tasks and background tasks
* instead of using this low level API.
*
*
* @param runnable the runnable that will be executed on the JavaFX Application Thread
* @throws InterruptedException if the JavaFX Application Thread was interrupted while waiting
* @throws ExecutionException if the call of the run method of the Runnable threw an exception
*/
public static void runAndWait(Runnable runnable)
throws InterruptedException, ExecutionException {
FutureTask future = new FutureTask<>(runnable, null);
Platform.runLater(future);
future.get();
}
/**
* Runs the given Callable on the JavaFX Application Thread. The method blocks until the Callable is executed completely. The return value of the call() method of the callable will be returned
* You should use the {@link io.datafx.core.concurrent.ProcessChain} for concurrent tasks and background tasks
* instead of using this low level API.
*
* @param callable the callable that will be executed on the JavaFX Application Thread
* @param return type of the callable
* @return return value of the executed call() method of the Callable
* @throws InterruptedException if the JavaFX Application Thread was interrupted while waiting
* @throws ExecutionException if the call of the run method of the Callable threw an exception
*/
public static T runCallableAndWait(Callable callable)
throws InterruptedException, ExecutionException {
FutureTask future = new FutureTask(callable);
Platform.runLater(future);
return future.get();
}
public static DataFxService createService(Runnable runnable) {
return createService(new RunnableBasedDataFxTask(runnable));
}
public static DataFxService createService(Callable callable) {
return createService(new CallableBasedDataFxTask(callable));
}
public static DataFxService createService(Task task) {
return new DataFxService() {
@Override
protected Task createTask() {
return task;
}
};
}
public static Worker executeService(Executor executor, Service service) {
if (executor != null && executor instanceof ObservableExecutor) {
return ((ObservableExecutor) executor).submit(service);
} else {
if (executor != null) {
service.setExecutor(executor);
}
service.start();
return service;
}
}
public static BooleanBinding isFinishedProperty(Worker worker) {
return worker.stateProperty().isEqualTo(Worker.State.CANCELLED).or(worker.stateProperty().isEqualTo(Worker.State.FAILED).or(worker.stateProperty().isEqualTo(Worker.State.SUCCEEDED)));
}
/**
* The given consumer will be called once the worker is finished. The result of the worker
* will be passed to the consumer.
* @param worker the worker
* @param consumer the consumer
* @param the resukt type of the worker
*/
public static void then(Worker worker, Consumer consumer) {
ReadOnlyBooleanProperty doneProperty = createIsDoneProperty(worker);
ChangeListener listener = (o, oldValue, newValue) -> {
if (newValue) {
consumer.accept(worker.getValue());
}
};
doneProperty.addListener(listener);
}
/**
* Returns a property that defines the state of the given worker. Once the worker is done the value of the
* property will be set to true
* @param worker the worker
* @return the property
*/
public static ReadOnlyBooleanProperty createIsDoneProperty(Worker worker) {
final BooleanProperty property = new SimpleBooleanProperty();
Consumer stateChecker = (s) -> {
if (s.equals(Worker.State.CANCELLED) || s.equals(Worker.State.FAILED) || s.equals(Worker.State.SUCCEEDED)) {
property.setValue(true);
} else {
property.setValue(false);
}
};
worker.stateProperty().addListener((o, oldValue, newValue) -> stateChecker.accept(newValue));
stateChecker.accept(worker.getState());
return property;
}
/**
* This methods blocks until the worker is done and returns the result value of the worker.
* If the worker was canceled an exception will be thrown.
*
* @param worker The worker
* @param result type of the worker
* @return the result
* @throws InterruptedException if the worker was canceled
*/
public static T waitFor(Worker worker) throws InterruptedException {
Lock lock = new ReentrantLock();
Condition condition = lock.newCondition();
lock.lock();
try {
ReadOnlyBooleanProperty doneProperty = createIsDoneProperty(worker);
if (doneProperty.get()) {
return worker.getValue();
} else {
doneProperty.addListener(e -> {
boolean locked = lock.tryLock();
if (locked) {
try {
condition.signal();
} finally {
lock.unlock();
}
} else {
throw new RuntimeException("Concurreny Error");
}
});
condition.await();
return worker.getValue();
}
} finally {
lock.unlock();
}
}
}