edu.emory.mathcs.util.concurrent
Class AbstractExecutorService

java.lang.Object
  |
  +--edu.emory.mathcs.util.concurrent.AbstractExecutorService
All Implemented Interfaces:
Executor, ExecutorService
Direct Known Subclasses:
ThreadPoolExecutor

public abstract class AbstractExecutorService
extends java.lang.Object
implements ExecutorService

Provides default implementation of ExecutorService execution methods. This class implements the submit, invokeAny and invokeAll methods using the default FutureTask class provided in this package. For example, the implementation of submit(Runnable) creates an associated FutureTask that is executed and returned. Subclasses overriding these methods to use different Future implementations should do so consistently for each of these methods.

Since:
1.5

Constructor Summary
AbstractExecutorService()
           
 
Method Summary
 java.util.List invokeAll(java.util.Collection tasks)
          Executes the given tasks, returning a list of Futures holding their status and results when all complete.
 java.util.List invokeAll(java.util.Collection tasks, long timeout, TimeUnit unit)
          Executes the given tasks, returning a list of Futures holding their status and results when all complete or the timeout expires, whichever happens first.
 java.lang.Object invokeAny(java.util.Collection tasks)
          Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do.
 java.lang.Object invokeAny(java.util.Collection tasks, long timeout, TimeUnit unit)
          Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do before the given timeout elapses.
 Future submit(Callable task)
          Submits a value-returning task for execution and returns a Future representing the pending results of the task.
 Future submit(java.lang.Runnable task)
          Submits a Runnable task for execution and returns a Future representing that task.
 Future submit(java.lang.Runnable task, java.lang.Object result)
          Submits a Runnable task for execution and returns a Future representing that task that will upon completion return the given result
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface edu.emory.mathcs.util.concurrent.ExecutorService
awaitTermination, isShutdown, isTerminated, shutdown, shutdownNow
 
Methods inherited from interface edu.emory.mathcs.util.concurrent.Executor
execute
 

Constructor Detail

AbstractExecutorService

public AbstractExecutorService()
Method Detail

submit

public Future submit(java.lang.Runnable task)
Description copied from interface: ExecutorService
Submits a Runnable task for execution and returns a Future representing that task.

Specified by:
submit in interface ExecutorService
Parameters:
task - the task to submit
Returns:
a Future representing pending completion of the task, and whose get() method will return null upon completion.

submit

public Future submit(java.lang.Runnable task,
                     java.lang.Object result)
Description copied from interface: ExecutorService
Submits a Runnable task for execution and returns a Future representing that task that will upon completion return the given result

Specified by:
submit in interface ExecutorService
Parameters:
task - the task to submit
result - the result to return
Returns:
a Future representing pending completion of the task, and whose get() method will return the given result upon completion.

submit

public Future submit(Callable task)
Description copied from interface: ExecutorService
Submits a value-returning task for execution and returns a Future representing the pending results of the task.

If you would like to immediately block waiting for a task, you can use constructions of the form result = exec.submit(aCallable).get();

Note: The Executors class includes a set of methods that can convert some other common closure-like objects, for example, PrivilegedAction to Callable form so they can be submitted.

Specified by:
submit in interface ExecutorService
Parameters:
task - the task to submit
Returns:
a Future representing pending completion of the task

invokeAny

public java.lang.Object invokeAny(java.util.Collection tasks)
                           throws java.lang.InterruptedException,
                                  ExecutionException
Description copied from interface: ExecutorService
Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do. Upon normal or exceptional return, tasks that have not completed are cancelled. The results of this method are undefined if the given collection is modified while this operation is in progress.

Specified by:
invokeAny in interface ExecutorService
Parameters:
tasks - the collection of tasks
Returns:
The result returned by one of the tasks.
Throws:
java.lang.InterruptedException - if interrupted while waiting
ExecutionException - if no task successfully completes

invokeAny

public java.lang.Object invokeAny(java.util.Collection tasks,
                                  long timeout,
                                  TimeUnit unit)
                           throws java.lang.InterruptedException,
                                  ExecutionException,
                                  TimeoutException
Description copied from interface: ExecutorService
Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do before the given timeout elapses. Upon normal or exceptional return, tasks that have not completed are cancelled. The results of this method are undefined if the given collection is modified while this operation is in progress.

Specified by:
invokeAny in interface ExecutorService
Parameters:
tasks - the collection of tasks
timeout - the maximum time to wait
unit - the time unit of the timeout argument
Returns:
The result returned by one of the tasks.
Throws:
ExecutionException - if no task successfully completes
TimeoutException - if the given timeout elapses before any task successfully completes
java.lang.InterruptedException - if interrupted while waiting

invokeAll

public java.util.List invokeAll(java.util.Collection tasks)
                         throws java.lang.InterruptedException
Description copied from interface: ExecutorService
Executes the given tasks, returning a list of Futures holding their status and results when all complete. Future.isDone() is true for each element of the returned list. Note that a completed task could have terminated either normally or by throwing an exception. The results of this method are undefined if the given collection is modified while this operation is in progress.

Specified by:
invokeAll in interface ExecutorService
Parameters:
tasks - the collection of tasks
Returns:
A list of Futures representing the tasks, in the same sequential order as produced by the iterator for the given task list, each of which has completed.
Throws:
java.lang.InterruptedException - if interrupted while waiting, in which case unfinished tasks are cancelled.

invokeAll

public java.util.List invokeAll(java.util.Collection tasks,
                                long timeout,
                                TimeUnit unit)
                         throws java.lang.InterruptedException
Description copied from interface: ExecutorService
Executes the given tasks, returning a list of Futures holding their status and results when all complete or the timeout expires, whichever happens first. Future.isDone() is true for each element of the returned list. Upon return, tasks that have not completed are cancelled. Note that a completed task could have terminated either normally or by throwing an exception. The results of this method are undefined if the given collection is modified while this operation is in progress.

Specified by:
invokeAll in interface ExecutorService
Parameters:
tasks - the collection of tasks
timeout - the maximum time to wait
unit - the time unit of the timeout argument
Returns:
A list of Futures representing the tasks, in the same sequential order as produced by the iterator for the given task list. If the operation did not time out, each task will have completed. If it did time out, some of these tasks will not have completed.
Throws:
java.lang.InterruptedException - if interrupted while waiting, in which case unfinished tasks are cancelled.