Module org.autogui

Package org.autogui.swing.util

Class SwingDeferredRunner

java.lang.Object

org.autogui.swing.util.SwingDeferredRunner

public class SwingDeferredRunner
extends Object

a task runner in the event dispatching thread without blocking

   try {
      Object ret = SwingDeferredRunner.run(task);
      if (ret instanceof SwingDeferredRunner.TaskResultFuture) {
         Future<Object> f = ((TaskResultFuture) ret).getFuture();
          ...
      } else {
          ...
      }
   } catch(Throwable errorWhileTask) { ... }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SwingDeferredRunner.Task	a function interface under the event dispatching thread
static class	SwingDeferredRunner.TaskResultError	a result for a thrown exception: SwingDeferredRunner.TaskResultFuture return the value if the task failed with an exception
static class	SwingDeferredRunner.TaskResultFuture	a incomplete result

Field Summary

Fields

Modifier and Type	Field	Description
static ExecutorService	defaultService
static ThreadLocal<Boolean>	dispatchedFromEventThread
protected Supplier<ExecutorService>	futureFactory
protected LinkedBlockingQueue<Object>	result
protected SwingDeferredRunner.Task	task
static Object	TASK_RESULT_NULL

Constructor Summary

Constructors

Constructor	Description
SwingDeferredRunner(Supplier<ExecutorService> futureFactory, SwingDeferredRunner.Task task)

Method Summary

Modifier and Type	Method	Description
static void	cleanDefaultService()
static ExecutorService	getDefaultService()
static void	invokeAndWait(Runnable r)	run the task by SwingUtilities.invokeAndWait(Runnable) with wrapping by ScheduledTaskRunner.withDepthInfo(String, Runnable) and ScheduledTaskRunner.depthRunner(Runnable)
static void	invokeLater(Runnable r)	run the task by SwingUtilities.invokeLater(Runnable) with wrapping by ScheduledTaskRunner.depthRunner(Runnable)
static boolean	isDispatchedFromEventThread()
static boolean	isEventThreadOrDispatchedFromEventThread()
Object	run()	execute the specified task on the event dispatching thread and return the result.
static Object	run(SwingDeferredRunner.Task task)

Methods inherited from class java.lang.Object

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

Field Details

result

protected LinkedBlockingQueue<Object> result

task

protected SwingDeferredRunner.Task task

futureFactory

protected Supplier<ExecutorService> futureFactory

dispatchedFromEventThread

public static ThreadLocal<Boolean> dispatchedFromEventThread

defaultService

public static ExecutorService defaultService

TASK_RESULT_NULL

public static Object TASK_RESULT_NULL

Constructor Details

SwingDeferredRunner

public SwingDeferredRunner(Supplier<ExecutorService> futureFactory,
 SwingDeferredRunner.Task task)

Method Details

isEventThreadOrDispatchedFromEventThread

public static boolean isEventThreadOrDispatchedFromEventThread()

isDispatchedFromEventThread

public static boolean isDispatchedFromEventThread()

invokeLater

public static void invokeLater(Runnable r)

run the task by SwingUtilities.invokeLater(Runnable) with wrapping by ScheduledTaskRunner.depthRunner(Runnable)

Parameters:

r - the task

invokeAndWait

public static void invokeAndWait(Runnable r)
                          throws InterruptedException,
InvocationTargetException

run the task by SwingUtilities.invokeAndWait(Runnable) with wrapping by ScheduledTaskRunner.withDepthInfo(String, Runnable) and ScheduledTaskRunner.depthRunner(Runnable)

Parameters:

r - the task

Throws:

InterruptedException - from invokeWait

InvocationTargetException - from invokeWait

getDefaultService

public static ExecutorService getDefaultService()

cleanDefaultService

public static void cleanDefaultService()

run

public static Object run(SwingDeferredRunner.Task task)
                  throws Throwable

Throws:

Throwable

run

public Object run()
           throws Throwable

execute the specified task on the event dispatching thread and return the result. if the current thread is the event dispatching thread, then it runs immediately. otherwise, submit the task to the event dispatching thread, and wait a little while and return a future value if it is not completed.

Returns:

the result of the task (nullable) if no-delaying, or SwingDeferredRunner.TaskResultFuture submitted to the futureFactory

Throws:

Throwable - if the task throws an exception without delay, then it is thrown