Package com.google.common.util.concurrent

Class FluentFuture.TrustedFuture<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.FluentFuture.TrustedFuture<V>

All Implemented Interfaces:

AbstractFuture.Trusted<V>, ListenableFuture<V>, java.util.concurrent.Future<V>

Direct Known Subclasses:

AbstractCatchingFuture, AbstractTransformFuture, TimeoutFuture, TrustedListenableFutureTask

Enclosing class:

FluentFuture<V>

abstract static class FluentFuture.TrustedFuture<V>
extends FluentFuture<V>
implements AbstractFuture.Trusted<V>

A less abstract subclass of AbstractFuture. This can be used to optimize setFuture by ensuring that get() calls exactly the implementation of AbstractFuture.get(long, java.util.concurrent.TimeUnit).

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>

Constructor Summary

Constructors

Constructor	Description
TrustedFuture()

Method Summary

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()

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, toString, tryInternalFastPathGetFailure, wasInterrupted

Methods inherited from class java.lang.Object

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

Constructor Detail

TrustedFuture

TrustedFuture()

Method Detail

get

public final V get()
            throws java.lang.InterruptedException,
                   java.util.concurrent.ExecutionException

Description copied from class: AbstractFuture

The default AbstractFuture implementation throws InterruptedException if the current thread is interrupted during the call, even if the value is already available.

Specified by:

get in interface java.util.concurrent.Future<V>

Overrides:

get in class AbstractFuture<V>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

get

public final 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 throws InterruptedException if the current thread is interrupted during the call, even if the value is already available.

Specified by:

get in interface java.util.concurrent.Future<V>

Overrides:

get in class AbstractFuture<V>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

isDone

public final boolean isDone()

Specified by:

isDone in interface java.util.concurrent.Future<V>

Overrides:

isDone in class AbstractFuture<V>

isCancelled

public final boolean isCancelled()

Specified by:

isCancelled in interface java.util.concurrent.Future<V>

Overrides:

isCancelled in class AbstractFuture<V>

addListener

public final 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 the Future'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., a RejectedExecutionException 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 -- consider MoreExecutors.directExecutor(). Otherwise, avoid it: See the warnings on the docs for directExecutor.

This is the most general listener interface. For common operations performed using listeners, see Futures. For a simplified but general listener interface, see addCallback().

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 interface ListenableFuture<V>

Overrides:

addListener in class AbstractFuture<V>

Parameters:

listener - the listener to run when the computation is complete

executor - the executor to run the listener in

cancel

public final 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 delegate Future that was supplied in the setFuture call.

Rather than override this method to perform additional cancellation work or cleanup, subclasses should override AbstractFuture.afterDone(), consulting AbstractFuture.isCancelled() and AbstractFuture.wasInterrupted() as necessary. This ensures that the work is done even if the future is cancelled without a call to cancel, such as by calling setFuture(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 interface java.util.concurrent.Future<V>

Overrides:

cancel in class AbstractFuture<V>