Package edu.wisc.ssec.mcidasv.util.nativepathchooser

Class SynchronousJFXCaller<T>

java.lang.Object

edu.wisc.ssec.mcidasv.util.nativepathchooser.SynchronousJFXCaller<T>

Type Parameters:

T - Return type of the Callable.

public class SynchronousJFXCaller<T>
extends Object

A utility class to execute a Callable synchronously on the JavaFX event thread.

Field Summary

Fields

Modifier and Type	Field	Description
private final Callable<T>	callable

Constructor Summary

Constructors

Constructor	Description
SynchronousJFXCaller(Callable<T> callable)	Constructs a new caller that will execute the provided callable.

Method Summary

Modifier and Type	Method	Description
T	call(long startTimeout, TimeUnit startTimeoutUnit)	Executes the Callable.

Methods inherited from class java.lang.Object

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

Field Details

callable

private final Callable<T> callable

Constructor Details

SynchronousJFXCaller

public SynchronousJFXCaller(Callable<T> callable)

Constructs a new caller that will execute the provided callable. The callable is accessed from the JavaFX event thread, so it should either be immutable or at least its state shouldn't be changed randomly while the call() method is in progress.

Parameters:

callable - Action to execute on the JFX event thread.

Method Details

call

public T call(long startTimeout,
 TimeUnit startTimeoutUnit)
       throws Exception

Executes the Callable.

A specialized task is run using Platform.runLater(). The calling thread then waits first for the task to start, then for it to return a result. Any exception thrown by the Callable will be rethrown in the calling thread.

Parameters:

startTimeout - time to wait for Platform.runLater() to start the dialog-showing task

startTimeoutUnit - the time unit of the startTimeout argument

Returns:

whatever the Callable returns

Throws:

IllegalStateException - if Platform.runLater() fails to start the task within the given timeout

InterruptedException - if the calling (this) thread is interrupted while waiting for the task to start or to get its result (note that the task will still run anyway and its result will be ignored)

Exception