Class ForwardingFluentFuture<V>
- java.lang.Object
-
- com.google.common.util.concurrent.internal.InternalFutureFailureAccess
-
- com.google.common.util.concurrent.AbstractFuture<V>
-
- com.google.common.util.concurrent.GwtFluentFutureCatchingSpecialization<V>
-
- com.google.common.util.concurrent.FluentFuture<V>
-
- com.google.common.util.concurrent.ForwardingFluentFuture<V>
-
- All Implemented Interfaces:
ListenableFuture<V>
,java.util.concurrent.Future<V>
final class ForwardingFluentFuture<V> extends FluentFuture<V>
FluentFuture
that forwards all calls to a delegate.Extension
If you want a class likeFluentFuture
but with extra methods, we recommend declaring your own subclass ofListenableFuture
, complete with a method likeFluentFuture.from(com.google.common.util.concurrent.ListenableFuture<V>)
to adapt an existingListenableFuture
, implemented atop aForwardingListenableFuture
that forwards to that future and adds the desired methods.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.common.util.concurrent.FluentFuture
FluentFuture.TrustedFuture<V>
-
Nested classes/interfaces inherited from class com.google.common.util.concurrent.AbstractFuture
AbstractFuture.Trusted<V>
-
-
Field Summary
Fields Modifier and Type Field Description private ListenableFuture<V>
delegate
-
Constructor Summary
Constructors Constructor Description ForwardingFluentFuture(ListenableFuture<V> delegate)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addListener(java.lang.Runnable listener, java.util.concurrent.Executor executor)
Registers a listener to be run on the given executor.boolean
cancel(boolean mayInterruptIfRunning)
V
get()
V
get(long timeout, java.util.concurrent.TimeUnit unit)
boolean
isCancelled()
boolean
isDone()
java.lang.String
toString()
-
Methods inherited from class com.google.common.util.concurrent.FluentFuture
addCallback, catching, catchingAsync, from, from, transform, transformAsync, withTimeout, withTimeout
-
Methods inherited from class com.google.common.util.concurrent.AbstractFuture
afterDone, interruptTask, maybePropagateCancellationTo, pendingToString, set, setException, setFuture, tryInternalFastPathGetFailure, wasInterrupted
-
-
-
-
Field Detail
-
delegate
private final ListenableFuture<V> delegate
-
-
Constructor Detail
-
ForwardingFluentFuture
ForwardingFluentFuture(ListenableFuture<V> delegate)
-
-
Method Detail
-
addListener
public void addListener(java.lang.Runnable listener, java.util.concurrent.Executor executor)
Description copied from class:AbstractFuture
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>
- Overrides:
addListener
in classAbstractFuture<V>
- Parameters:
listener
- the listener to run when the computation is completeexecutor
- the executor to run the listener in
-
cancel
public boolean cancel(boolean mayInterruptIfRunning)
Description copied from class:AbstractFuture
If a cancellation attempt succeeds on a
Future
that had previously been set asynchronously, then the cancellation will also be propagated to the delegateFuture
that was supplied in thesetFuture
call.Rather than override this method to perform additional cancellation work or cleanup, subclasses should override
AbstractFuture.afterDone()
, consultingAbstractFuture.isCancelled()
andAbstractFuture.wasInterrupted()
as necessary. This ensures that the work is done even if the future is cancelled without a call tocancel
, such as by callingsetFuture(cancelledFuture)
.Beware of completing a future while holding a lock. Its listeners may do slow work or acquire other locks, risking deadlocks.
- Specified by:
cancel
in interfacejava.util.concurrent.Future<V>
- Overrides:
cancel
in classAbstractFuture<V>
-
isCancelled
public boolean isCancelled()
- Specified by:
isCancelled
in interfacejava.util.concurrent.Future<V>
- Overrides:
isCancelled
in classAbstractFuture<V>
-
isDone
public boolean isDone()
- Specified by:
isDone
in interfacejava.util.concurrent.Future<V>
- Overrides:
isDone
in classAbstractFuture<V>
-
get
public V get() throws java.lang.InterruptedException, java.util.concurrent.ExecutionException
Description copied from class:AbstractFuture
The default
AbstractFuture
implementation throwsInterruptedException
if the current thread is interrupted during the call, even if the value is already available.- Specified by:
get
in interfacejava.util.concurrent.Future<V>
- Overrides:
get
in classAbstractFuture<V>
- Throws:
java.lang.InterruptedException
java.util.concurrent.ExecutionException
-
get
public V get(long timeout, java.util.concurrent.TimeUnit unit) throws java.lang.InterruptedException, java.util.concurrent.ExecutionException, java.util.concurrent.TimeoutException
Description copied from class:AbstractFuture
The default
AbstractFuture
implementation throwsInterruptedException
if the current thread is interrupted during the call, even if the value is already available.- Specified by:
get
in interfacejava.util.concurrent.Future<V>
- Overrides:
get
in classAbstractFuture<V>
- Throws:
java.lang.InterruptedException
java.util.concurrent.ExecutionException
java.util.concurrent.TimeoutException
-
toString
public java.lang.String toString()
- Overrides:
toString
in classAbstractFuture<V>
-
-