Module dev.mccue.guava.concurrent
Package dev.mccue.guava.concurrent

Class SettableFuture<V extends @Nullable Object>

java.lang.Object
dev.mccue.guava.concurrent.internal.InternalFutureFailureAccess
dev.mccue.guava.concurrent.AbstractFuture<V>
dev.mccue.guava.concurrent.SettableFuture<V>
All Implemented Interfaces:
ListenableFuture<V>, Future<V>
public final class SettableFuture<V extends @Nullable Object> extends AbstractFuture<V>
A ListenableFuture whose result can be set by a #set(Object), #setException(Throwable) or #setFuture(ListenableFuture) call. It can also, like any other Future, be #cancel cancelled.

SettableFuture is the recommended ListenableFuture implementation when your task cannot be implemented with ListeningExecutorService, the various Futures utility methods, or ListenableFutureTask. Those APIs have less opportunity for developer error. If your needs are more complex than SettableFuture supports, use AbstractFuture, which offers an extensible version of the API.

Since:
9.0 (in 1.0 as ValueFuture)
Author:
Sven Mawson

  • Method Details

    • create

      public static <V extends @Nullable Object> SettableFuture<V> create()
      Creates a new SettableFuture that can be completed or cancelled by a later method call.

    • set

      @CanIgnoreReturnValue public boolean set(V value)
      Description copied from class: AbstractFuture
      Sets the result of this Future unless this Future has already been cancelled or set (including #setFuture set asynchronously). When a call to this method returns, the Future is guaranteed to be #isDone done only if the call was accepted (in which case it returns true). If it returns false, the Future may have previously been set asynchronously, in which case its result may not be known yet. That result, though not yet known, cannot be overridden by a call to a set* method, only by a call to #cancel.

      Beware of completing a future while holding a lock. Its listeners may do slow work or acquire other locks, risking deadlocks.

      Overrides:
      set in class AbstractFuture<V extends @Nullable Object>
      Parameters:
      value - the value to be used as the result
      Returns:
      true if the attempt was accepted, completing the Future

    • setException

      @CanIgnoreReturnValue public boolean setException(Throwable throwable)
      Description copied from class: AbstractFuture
      Sets the failed result of this Future unless this Future has already been cancelled or set (including #setFuture set asynchronously). When a call to this method returns, the Future is guaranteed to be #isDone done only if the call was accepted (in which case it returns true). If it returns false, the Future may have previously been set asynchronously, in which case its result may not be known yet. That result, though not yet known, cannot be overridden by a call to a set* method, only by a call to #cancel.

      Beware of completing a future while holding a lock. Its listeners may do slow work or acquire other locks, risking deadlocks.

      Overrides:
      setException in class AbstractFuture<V extends @Nullable Object>
      Parameters:
      throwable - the exception to be used as the failed result
      Returns:
      true if the attempt was accepted, completing the Future

    • setFuture

      @CanIgnoreReturnValue public boolean setFuture(ListenableFuture<? extends V> future)
      Description copied from class: AbstractFuture
      Sets the result of this Future to match the supplied input Future once the supplied Future is done, unless this Future has already been cancelled or set (including "set asynchronously," defined below).

      If the supplied future is #isDone done when this method is called and the call is accepted, then this future is guaranteed to have been completed with the supplied future by the time this method returns. If the supplied future is not done and the call is accepted, then the future will be set asynchronously. Note that such a result, though not yet known, cannot be overridden by a call to a set* method, only by a call to #cancel.

      If the call setFuture(delegate) is accepted and this Future is later cancelled, cancellation will be propagated to delegate. Additionally, any call to setFuture after any cancellation will propagate cancellation to the supplied Future.

      Note that, even if the supplied future is cancelled and it causes this future to complete, it will never trigger interruption behavior. In particular, it will not cause this future to invoke the #interruptTask method, and the #wasInterrupted method will not return true.

      Beware of completing a future while holding a lock. Its listeners may do slow work or acquire other locks, risking deadlocks.

      Overrides:
      setFuture in class AbstractFuture<V extends @Nullable Object>
      Parameters:
      future - the future to delegate to
      Returns:
      true if the attempt was accepted, indicating that the Future was not previously cancelled or set.

    • get

      @CanIgnoreReturnValue public final V get() throws InterruptedException, 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 Future<V extends @Nullable Object>
      Overrides:
      get in class AbstractFuture<V extends @Nullable Object>
      Throws:
      InterruptedException
      ExecutionException

    • get

      @CanIgnoreReturnValue public final V get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, 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 Future<V extends @Nullable Object>
      Overrides:
      get in class AbstractFuture<V extends @Nullable Object>
      Throws:
      InterruptedException
      ExecutionException
      TimeoutException

    • isDone

      public final boolean isDone()
      Specified by:
      isDone in interface Future<V extends @Nullable Object>
      Overrides:
      isDone in class AbstractFuture<V extends @Nullable Object>

    • isCancelled

      public final boolean isCancelled()
      Specified by:
      isCancelled in interface Future<V extends @Nullable Object>
      Overrides:
      isCancelled in class AbstractFuture<V extends @Nullable Object>

    • addListener

      public final void addListener(Runnable listener, Executor executor)
      Description copied from class: AbstractFuture
      Registers a listener to be Executor#execute(Runnable) run on the given executor. The listener will run when the Future's computation is Future#isDone() 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 MoreExecutors#directExecutor 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 Futures#addCallback 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 extends @Nullable Object>
      Overrides:
      addListener in class AbstractFuture<V extends @Nullable Object>
      Parameters:
      listener - the listener to run when the computation is complete
      executor - the executor to run the listener in

    • cancel

      @CanIgnoreReturnValue public final boolean cancel(boolean mayInterruptIfRunning)
      Description copied from class: AbstractFuture

      If a cancellation attempt succeeds on a Future that had previously been #setFuture 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 #afterDone, consulting #isCancelled and #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 Future<V extends @Nullable Object>
      Overrides:
      cancel in class AbstractFuture<V extends @Nullable Object>