|
FlexDoc/Javadoc 2.0 Demo Java Doc |
Class AbstractExecutorService
java.util.concurrent.AbstractExecutorService
All Implemented Interfaces:
Direct Known Subclasses:
public abstract class AbstractExecutorService
Provides default implementations of
ExecutorService
execution methods. This class implements the
submit,
invokeAny and
invokeAll methods using a
RunnableFuture returned by
newTaskFor, which defaults
to the
FutureTask class provided in this package. For example,
the implementation of
submit(Runnable) creates an
associated
RunnableFuture that is executed and
returned. Subclasses may override the
newTaskFor methods
to return
RunnableFuture implementations other than
FutureTask.
Extension example. Here is a sketch of a class
that customizes ThreadPoolExecutor to use
a CustomTask class instead of the default FutureTask:
public class CustomThreadPoolExecutor extends ThreadPoolExecutor {
static class CustomTask<V> implements RunnableFuture<V> { ... }
protected <V> RunnableFuture<V> newTaskFor(Callable<V> c) {
return new CustomTask<V>(c);
}
protected <V> RunnableFuture<V> newTaskFor(Runnable r, V v) {
return new CustomTask<V>(r, v);
}
// ... add constructors, etc.
}
Since:
1.5
Author:
Doug Lea
Constructor Summary |
Constructor for subclasses to call.
|
Method Summary |
|
Executes the given tasks, returning a list of Futures holding
their status and results when all complete.
|
|
Executes the given tasks, returning a list of Futures holding
their status and results
when all complete or the timeout expires, whichever happens first.
|
|
Executes the given tasks, returning the result
of one that has completed successfully (i.e., without throwing
an exception), if any do.
|
|
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.
|
|
Returns a RunnableFuture for the given callable task.
|
|
Returns a RunnableFuture for the given runnable and default
value.
|
|
Submits a value-returning task for execution and returns a
Future representing the pending results of the task.
|
|
Submits a Runnable task for execution and returns a Future
representing that task.
|
|
Submits a Runnable task for execution and returns a Future
representing that task.
|
Methods inherited from class java.lang. Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface java.util.concurrent. Executor |
|
public AbstractExecutorService |
() |
Constructor for subclasses to call.
Returns a
RunnableFuture for the given runnable and default
value.
Type Parameters:
T - the type of the given value
Parameters:
runnable - the runnable task being wrapped
value - the default value for the returned future
Returns:
a RunnableFuture which, when run, will run the
underlying runnable and which, as a Future, will yield
the given value as its result and provide for cancellation of
the underlying task
Since:
1.6
Returns a
RunnableFuture for the given callable task.
Type Parameters:
T - the type of the callable's result
Parameters:
callable - the callable task being wrapped
Returns:
a RunnableFuture which, when run, will call the
underlying callable and which, as a Future, will yield
the callable's result as its result and provide for
cancellation of the underlying task
Since:
1.6
Submits a Runnable task for execution and returns a Future
representing that task. The Future's get method will
return null upon successful completion.
Specified by:
Parameters:
task - the task to submit
Returns:
a Future representing pending completion of the task
Throws:
Submits a Runnable task for execution and returns a Future
representing that task. The Future's get method will
return the given result upon successful completion.
Specified by:
Type Parameters:
T - the type of the result
Parameters:
task - the task to submit
result - the result to return
Returns:
a Future representing pending completion of the task
Throws:
Submits a value-returning task for execution and returns a
Future representing the pending results of the task. The
Future's
get method will return the task's result upon
successful completion.
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:
Type Parameters:
T - the type of the task's result
Parameters:
task - the task to submit
Returns:
a Future representing pending completion of the task
Throws:
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:
Type Parameters:
T - the type of the values returned from the tasks
Parameters:
tasks - the collection of tasks
Returns:
the result returned by one of the tasks
Throws:
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:
Type Parameters:
T - the type of the values returned from the tasks
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:
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:
Type Parameters:
T - the type of the values returned from the tasks
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:
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:
Type Parameters:
T - the type of the values returned from the tasks
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:
|
FlexDoc/Javadoc 2.0 Demo Java Doc |
FlexDoc/Javadoc is a template-driven programming tool for rapid development of any Javadoc-based Java API documentation generators (i.e. doclets). If you need to customize your Javadoc without writing a full-blown doclet from scratch,
FlexDoc/Javadoc may be the only tool able to help you! Find out more at
www.flexdoc.xyz