Class JdkFutureAdapters.ListenableFutureAdapter<V>
- java.lang.Object
-
- com.google.common.collect.ForwardingObject
-
- com.google.common.util.concurrent.ForwardingFuture<V>
-
- com.google.common.util.concurrent.JdkFutureAdapters.ListenableFutureAdapter<V>
-
- All Implemented Interfaces:
ListenableFuture<V>
,java.util.concurrent.Future<V>
- Enclosing class:
- JdkFutureAdapters
private static class JdkFutureAdapters.ListenableFutureAdapter<V> extends ForwardingFuture<V> implements ListenableFuture<V>
An adapter to turn aFuture
into aListenableFuture
. This will wait on the future to finish, and when it completes, run the listeners. This implementation will wait on the source future indefinitely, so if the source future never completes, the adapter will never complete either.If the delegate future is interrupted or throws an unexpected unchecked exception, the listeners will not be invoked.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.common.util.concurrent.ForwardingFuture
ForwardingFuture.SimpleForwardingFuture<V>
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.concurrent.Executor
adapterExecutor
private static java.util.concurrent.Executor
defaultAdapterExecutor
private java.util.concurrent.Future<V>
delegate
private ExecutionList
executionList
private java.util.concurrent.atomic.AtomicBoolean
hasListeners
private static java.util.concurrent.ThreadFactory
threadFactory
-
Constructor Summary
Constructors Constructor Description ListenableFutureAdapter(java.util.concurrent.Future<V> delegate)
ListenableFutureAdapter(java.util.concurrent.Future<V> delegate, java.util.concurrent.Executor adapterExecutor)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addListener(java.lang.Runnable listener, java.util.concurrent.Executor exec)
Registers a listener to be run on the given executor.protected java.util.concurrent.Future<V>
delegate()
Returns the backing delegate instance that methods are forwarded to.-
Methods inherited from class com.google.common.util.concurrent.ForwardingFuture
cancel, get, get, isCancelled, isDone
-
Methods inherited from class com.google.common.collect.ForwardingObject
toString
-
-
-
-
Field Detail
-
threadFactory
private static final java.util.concurrent.ThreadFactory threadFactory
-
defaultAdapterExecutor
private static final java.util.concurrent.Executor defaultAdapterExecutor
-
adapterExecutor
private final java.util.concurrent.Executor adapterExecutor
-
executionList
private final ExecutionList executionList
-
hasListeners
private final java.util.concurrent.atomic.AtomicBoolean hasListeners
-
delegate
private final java.util.concurrent.Future<V> delegate
-
-
Method Detail
-
delegate
protected java.util.concurrent.Future<V> 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 classForwardingFuture<V>
-
addListener
public void addListener(java.lang.Runnable listener, java.util.concurrent.Executor exec)
Description copied from interface:ListenableFuture
Registers a listener to be run on the given executor. The listener will run when theFuture
's computation is complete or, if the computation is already complete, immediately.There is no guaranteed ordering of execution of listeners, but any listener added through this method is guaranteed to be called once the computation is complete.
Exceptions thrown by a listener will be propagated up to the executor. Any exception thrown during
Executor.execute
(e.g., aRejectedExecutionException
or an exception thrown by direct execution) will be caught and logged.Note: If your listener is lightweight -- and will not cause stack overflow by completing more futures or adding more
directExecutor()
listeners inline -- considerMoreExecutors.directExecutor()
. Otherwise, avoid it: See the warnings on the docs fordirectExecutor
.This is the most general listener interface. For common operations performed using listeners, see
Futures
. For a simplified but general listener interface, seeaddCallback()
.Memory consistency effects: Actions in a thread prior to adding a listener happen-before its execution begins, perhaps in another thread.
Guava implementations of
ListenableFuture
promptly release references to listeners after executing them.- Specified by:
addListener
in interfaceListenableFuture<V>
- Parameters:
listener
- the listener to run when the computation is completeexec
- the executor to run the listener in
-
-