de.javagl.swing.tasks.executors

Class ObservableExecutorService

java.lang.Object

java.util.concurrent.AbstractExecutorService

java.util.concurrent.ThreadPoolExecutor

de.javagl.swing.tasks.executors.ObservableExecutorService

All Implemented Interfaces:

Executor, ExecutorService

public class ObservableExecutorService
extends ThreadPoolExecutor

An executor service that may notify ExecutorObserver instances about the progress of processing the submitted tasks.

Note that the task observation will only be possible for tasks that are actually submitted using AbstractExecutorService.submit(Runnable), AbstractExecutorService.submit(Callable) or AbstractExecutorService.submit(Runnable, Object). It will not be possible for tasks that are submitted with execute(Runnable).

Instances of this class may be passed to an ObservableExecutorPanel, which will track the task execution and display information about the active tasks and in the UI. If the tasks that are submitted to this executor service implement the ProgressTask interface (for example, instances of the GenericProgressTask class), then the UI may show additional information about the progress of each individual task.

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.ThreadPoolExecutor

ThreadPoolExecutor.AbortPolicy, ThreadPoolExecutor.CallerRunsPolicy, ThreadPoolExecutor.DiscardOldestPolicy, ThreadPoolExecutor.DiscardPolicy

Method Summary

Modifier and Type	Method and Description
void	addExecutorObserver(ExecutorObserver executorObserver) Add the given ExecutorObserver to be informed about the progress of the task execution.
protected void	afterExecute(Runnable r, Throwable t)
protected void	beforeExecute(Thread t, Runnable r)
void	execute(Runnable command)
protected <V> RunnableFuture<V>	newTaskFor(Callable<V> c)
protected <V> RunnableFuture<V>	newTaskFor(Runnable r, V v)
void	removeExecutorObserver(ExecutorObserver executorObserver) Remove the given ExecutorObserver

Methods inherited from class java.util.concurrent.ThreadPoolExecutor

allowCoreThreadTimeOut, allowsCoreThreadTimeOut, awaitTermination, finalize, getActiveCount, getCompletedTaskCount, getCorePoolSize, getKeepAliveTime, getLargestPoolSize, getMaximumPoolSize, getPoolSize, getQueue, getRejectedExecutionHandler, getTaskCount, getThreadFactory, isShutdown, isTerminated, isTerminating, prestartAllCoreThreads, prestartCoreThread, purge, remove, setCorePoolSize, setKeepAliveTime, setMaximumPoolSize, setRejectedExecutionHandler, setThreadFactory, shutdown, shutdownNow, terminated, toString

Methods inherited from class java.util.concurrent.AbstractExecutorService

invokeAll, invokeAll, invokeAny, invokeAny, submit, submit, submit

Methods inherited from class java.lang.Object

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

Method Detail

addExecutorObserver

public final void addExecutorObserver(ExecutorObserver executorObserver)

Add the given ExecutorObserver to be informed about the progress of the task execution.

The given observer may not be null. If the observer throws an exception in one of its methods, then an error message will be printed. Beyond that, the exceptions will be ignored.

Parameters:

executorObserver - The ExecutorObserver

removeExecutorObserver

public final void removeExecutorObserver(ExecutorObserver executorObserver)

Remove the given ExecutorObserver

Parameters:

executorObserver - The ExecutorObserver

newTaskFor

protected final <V> RunnableFuture<V> newTaskFor(Callable<V> c)

Overrides:

newTaskFor in class AbstractExecutorService

newTaskFor

protected final <V> RunnableFuture<V> newTaskFor(Runnable r,
                                                 V v)

Overrides:

newTaskFor in class AbstractExecutorService

execute

public void execute(Runnable command)

Specified by:

execute in interface Executor

Overrides:

execute in class ThreadPoolExecutor

beforeExecute

protected void beforeExecute(Thread t,
                             Runnable r)

Overrides:

beforeExecute in class ThreadPoolExecutor

afterExecute

protected void afterExecute(Runnable r,
                            Throwable t)

Overrides:

afterExecute in class ThreadPoolExecutor