Package com.google.common.util.concurrent

Class ForwardingListeningExecutorService

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.util.concurrent.ForwardingExecutorService

com.google.common.util.concurrent.ForwardingListeningExecutorService

All Implemented Interfaces:

ListeningExecutorService, Executor, ExecutorService

@CanIgnoreReturnValue
@GwtIncompatible
public abstract class ForwardingListeningExecutorService
extends ForwardingExecutorService
implements ListeningExecutorService

A listening executor service which forwards all its method calls to another listening executor service. Subclasses should override one or more methods to modify the behavior of the backing executor service as desired per the decorator pattern.

Since:

10.0

Author:

Isaac Shum

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ForwardingListeningExecutorService()	Constructor for use by subclasses.

Method Summary

Modifier and Type	Method	Description
protected abstract ListeningExecutorService	delegate()	Returns the backing delegate instance that methods are forwarded to.
ListenableFuture<?>	submit(Runnable task)	Submits a Runnable task for execution and returns a Future representing that task.
<T> ListenableFuture<T>	submit(Runnable task, T result)	Submits a Runnable task for execution and returns a Future representing that task.
<T> ListenableFuture<T>	submit(Callable<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.util.concurrent.ForwardingExecutorService

awaitTermination, execute, invokeAll, invokeAll, invokeAny, invokeAny, isShutdown, isTerminated, shutdown, shutdownNow

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.Executor

execute

Methods inherited from interface java.util.concurrent.ExecutorService

awaitTermination, invokeAny, invokeAny, isShutdown, isTerminated, shutdown, shutdownNow

Methods inherited from interface com.google.common.util.concurrent.ListeningExecutorService

invokeAll, invokeAll

Constructor Detail

ForwardingListeningExecutorService

protected ForwardingListeningExecutorService()

Constructor for use by subclasses.

Method Detail

delegate

protected abstract ListeningExecutorService 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 as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.

Specified by:

delegate in class ForwardingExecutorService

submit

public <T> ListenableFuture<T> submit(Callable<T> task)

Description copied from interface: java.util.concurrent.ExecutorService

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:

submit in interface ExecutorService

Specified by:

submit in interface ListeningExecutorService

Overrides:

submit in class ForwardingExecutorService

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 ListenableFuture<?> submit(Runnable task)

Description copied from interface: java.util.concurrent.ExecutorService

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:

submit in interface ExecutorService

Specified by:

submit in interface ListeningExecutorService

Overrides:

submit in class ForwardingExecutorService

Parameters:

task - the task to submit

Returns:

a Future representing pending completion of the task

submit

public <T> ListenableFuture<T> submit(Runnable task,
                                      T result)

Description copied from interface: java.util.concurrent.ExecutorService

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:

submit in interface ExecutorService

Specified by:

submit in interface ListeningExecutorService

Overrides:

submit in class ForwardingExecutorService

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