org.icij.concurrent

Class ExecutorProxy

java.lang.Object

org.icij.concurrent.ExecutorProxy

All Implemented Interfaces:

Shutdownable

Direct Known Subclasses:

DocumentConsumer, DocumentQueueDrainer, Scanner

public abstract class ExecutorProxy
extends Object
implements Shutdownable

A class of traits used by implementing classes that proxy an executor.

Field Summary

Fields

Modifier and Type	Field and Description
protected ExecutorService	executor The executor proxied by the implementing class.

Constructor Summary

Constructors

Constructor and Description
ExecutorProxy(ExecutorService executor) Instantiate a proxy for the given executor.

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long timeout, TimeUnit unit) Blocks until all the queued tasks have finished and the thread pool is empty, or the timeout is reached (whichever first).
void	shutdown() Shuts down the executor.
List<Runnable>	shutdownNow() Shut down the executor immediately, halting running tasks and discarding waiting tasks.

Methods inherited from class java.lang.Object

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

Field Detail

executor

protected final ExecutorService executor

The executor proxied by the implementing class.

Constructor Detail

ExecutorProxy

public ExecutorProxy(ExecutorService executor)

Instantiate a proxy for the given executor.

Parameters:

executor - the executor to proxy

Method Detail

shutdown

public void shutdown()

Shuts down the executor. This method should be called to free up resources when the executor is no longer needed. Running tasks will be allowed to complete but threads waiting on a blocking call to submit tasks to the executor will receive a RejectedExecutionException after this method is called.

Specified by:

shutdown in interface Shutdownable

shutdownNow

public List<Runnable> shutdownNow()

Shut down the executor immediately, halting running tasks and discarding waiting tasks.

Returns:

list of tasks that never commenced execution if using an ExecutorService that allows tasks to be queued, otherwise an empty list if using a blocking executor.

awaitTermination

public boolean awaitTermination(long timeout,
                                TimeUnit unit)
                         throws InterruptedException

Blocks until all the queued tasks have finished and the thread pool is empty, or the timeout is reached (whichever first). This method should be called to free up resources when the executor is no longer needed.

Returns:

true if the executor terminated before the given timeout, false otherwise.

Throws:

InterruptedException - if interrupted while waiting