Class ForwardingFluentFuture<V>
- All Implemented Interfaces:
ListenableFuture<V>,Future<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 of ListenableFuture, complete with a method like FluentFuture.from(com.google.common.util.concurrent.ListenableFuture<V>) to adapt an
existing ListenableFuture, implemented atop a ForwardingListenableFuture 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
FieldsFields inherited from class com.google.common.util.concurrent.AbstractFuture
GENERATE_CANCELLATION_CAUSES -
Constructor Summary
Constructors -
Method Summary
Methods inherited from class com.google.common.util.concurrent.FluentFuture
addCallback, catching, catchingAsync, from, from, transform, transformAsync, withTimeout, withTimeoutMethods inherited from class com.google.common.util.concurrent.AbstractFuture
afterDone, interruptTask, maybePropagateCancellationTo, pendingToString, set, setException, setFuture, tryInternalFastPathGetFailure, wasInterrupted
-
Field Details
-
delegate
-
-
Constructor Details
-
ForwardingFluentFuture
ForwardingFluentFuture(ListenableFuture<V> delegate)
-
-
Method Details
-
addListener
Description copied from class:AbstractFutureRegisters 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., aRejectedExecutionExceptionor 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
ListenableFuturepromptly release references to listeners after executing them.- Specified by:
addListenerin interfaceListenableFuture<V>- Overrides:
addListenerin 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:AbstractFutureIf a cancellation attempt succeeds on a
Futurethat had previously been set asynchronously, then the cancellation will also be propagated to the delegateFuturethat was supplied in thesetFuturecall.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.
-
isCancelled
public boolean isCancelled()- Specified by:
isCancelledin interfaceFuture<V>- Overrides:
isCancelledin classAbstractFuture<V>
-
isDone
public boolean isDone() -
get
Description copied from class:AbstractFutureThe default
AbstractFutureimplementation throwsInterruptedExceptionif the current thread is interrupted during the call, even if the value is already available.- Specified by:
getin interfaceFuture<V>- Overrides:
getin classAbstractFuture<V>- Throws:
InterruptedExceptionExecutionException
-
get
public V get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException Description copied from class:AbstractFutureThe default
AbstractFutureimplementation throwsInterruptedExceptionif the current thread is interrupted during the call, even if the value is already available.- Specified by:
getin interfaceFuture<V>- Overrides:
getin classAbstractFuture<V>- Throws:
InterruptedExceptionExecutionExceptionTimeoutException
-
toString
- Overrides:
toStringin classAbstractFuture<V>
-