Class ForwardingExecutorService
-
- com.google.common.collect.ForwardingObject
-
- com.google.common.util.concurrent.ForwardingExecutorService
-
- All Implemented Interfaces:
,
- Direct Known Subclasses:
ForwardingListeningExecutorService
@GwtIncompatible public abstract class ForwardingExecutorService extends ForwardingObject implements
An executor service which forwards all its method calls to another executor service. Subclasses should override one or more methods to modify the behavior of the backing executor service as desired per the .- Since:
- 10.0
- Author:
- Kurt Alfred Kluever
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ForwardingExecutorService()
Constructor for use by subclasses.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long timeout, unit)
Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.protected abstract
delegate()
Returns the backing delegate instance that methods are forwarded to.void
command)
Executes the given command at some time in the future.<T> <<T>>
<? extends <T>> tasks)
Executes the given tasks, returning a list of Futures holding their status and results when all complete.<T> <<T>>
<? extends <T>> tasks, long timeout, 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.<T> T
<? extends <T>> tasks)
Executes the given tasks, returning the result of one that has completed successfully (i.e., without throwing an exception), if any do.<T> T
<? extends <T>> tasks, long timeout, 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.boolean
isShutdown()
Returnstrue
if this executor has been shut down.boolean
isTerminated()
Returnstrue
if all tasks have completed following shut down.void
shutdown()
Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.<>
shutdownNow()
Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution.<?>
task)
Submits a Runnable task for execution and returns a Future representing that task.<T> <T>
task, T result)
Submits a Runnable task for execution and returns a Future representing that task.<T> <T>
<T> task)
Submits a value-returning task for execution and returns a Future representing the pending results of the task.-
Methods inherited from class com.google.common.collect.ForwardingObject
toString
-
-
-
-
Constructor Detail
-
ForwardingExecutorService
protected ForwardingExecutorService()
Constructor for use by subclasses.
-
-
Method Detail
-
delegate
protected abstract delegate()
Description copied from class:ForwardingObject
Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such asForwardingSet.delegate()
. Concrete subclasses override this method to supply the instance being decorated.- Specified by:
delegate
in classForwardingObject
-
awaitTermination
public boolean awaitTermination(long timeout, unit) throws
Description copied from interface:Blocks until all tasks have completed execution after a shutdown request, or the timeout occurs, or the current thread is interrupted, whichever happens first.- Specified by:
in interface
- Parameters:
timeout
- the maximum time to waitunit
- the time unit of the timeout argument- Returns:
true
if this executor terminated andfalse
if the timeout elapsed before termination- Throws:
- if interrupted while waiting
-
invokeAll
public <T> <<T>> <? extends <T>> tasks) throws
Description copied from interface:Executes the given tasks, returning a list of Futures holding their status and results when all complete. istrue
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:
in interface
- 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:
- if interrupted while waiting, in which case unfinished tasks are cancelled
-
invokeAll
public <T> <<T>> <? extends <T>> tasks, long timeout, unit) throws
Description copied from interface:Executes the given tasks, returning a list of Futures holding their status and results when all complete or the timeout expires, whichever happens first. istrue
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:
in interface
- Type Parameters:
T
- the type of the values returned from the tasks- Parameters:
tasks
- the collection of taskstimeout
- the maximum time to waitunit
- 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:
- if interrupted while waiting, in which case unfinished tasks are cancelled
-
invokeAny
public <T> T <? extends <T>> tasks) throws ,
Description copied from interface: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:
in interface
- 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:
- if interrupted while waiting
- if no task successfully completes
-
invokeAny
public <T> T <? extends <T>> tasks, long timeout, unit) throws , ,
Description copied from interface: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:
in interface
- Type Parameters:
T
- the type of the values returned from the tasks- Parameters:
tasks
- the collection of taskstimeout
- the maximum time to waitunit
- the time unit of the timeout argument- Returns:
- the result returned by one of the tasks
- Throws:
- if interrupted while waiting
- if no task successfully completes
- if the given timeout elapses before any task successfully completes
-
isShutdown
public boolean isShutdown()
Description copied from interface:Returnstrue
if this executor has been shut down.- Specified by:
in interface
- Returns:
true
if this executor has been shut down
-
isTerminated
public boolean isTerminated()
Description copied from interface:Returnstrue
if all tasks have completed following shut down. Note thatisTerminated
is nevertrue
unless eithershutdown
orshutdownNow
was called first.- Specified by:
in interface
- Returns:
true
if all tasks have completed following shut down
-
shutdown
public void shutdown()
Description copied from interface:Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down.This method does not wait for previously submitted tasks to complete execution. Use to do that.
- Specified by:
in interface
-
shutdownNow
public <> shutdownNow()
Description copied from interface:Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution.This method does not wait for actively executing tasks to terminate. Use to do that.
There are no guarantees beyond best-effort attempts to stop processing actively executing tasks. For example, typical implementations will cancel via , so any task that fails to respond to interrupts may never terminate.
- Specified by:
in interface
- Returns:
- list of tasks that never commenced execution
-
execute
public void command)
Description copied from interface:Executes the given command at some time in the future. The command may execute in a new thread, in a pooled thread, or in the calling thread, at the discretion of theExecutor
implementation.- Specified by:
in interface
- Parameters:
command
- the runnable task
-
submit
public <T> <T> <T> task)
Description copied from interface:Submits a value-returning task for execution and returns a Future representing the pending results of the task. The Future'sget
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 class includes a set of methods that can convert some other common closure-like objects, for example, to form so they can be submitted.
- Specified by:
in interface
- 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
-
submit
public <?> task)
Description copied from interface:Submits a Runnable task for execution and returns a Future representing that task. The Future'sget
method will returnnull
upon successful completion.- Specified by:
in interface
- Parameters:
task
- the task to submit- Returns:
- a Future representing pending completion of the task
-
submit
public <T> <T> task, T result)
Description copied from interface:Submits a Runnable task for execution and returns a Future representing that task. The Future'sget
method will return the given result upon successful completion.- Specified by:
in interface
- Type Parameters:
T
- the type of the result- Parameters:
task
- the task to submitresult
- the result to return- Returns:
- a Future representing pending completion of the task
-
-