Class SettableFuture<V>

    • Constructor Detail

      • SettableFuture

        private SettableFuture()
    • Method Detail

      • create

        public static <V> SettableFuture<V> create()
        Creates a new SettableFuture that can be completed or cancelled by a later method call.
      • set

        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 set asynchronously). When a call to this method returns, the Future is guaranteed to be 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 AbstractFuture.cancel(boolean).
        Overrides:
        set in class AbstractFuture<V>
        Parameters:
        value - the value to be used as the result
        Returns:
        true if the attempt was accepted, completing the Future
      • setException

        public boolean setException​(java.lang.Throwable throwable)
        Description copied from class: AbstractFuture
        Sets the failed result of this Future unless this Future has already been cancelled or set (including set asynchronously). When a call to this method returns, the Future is guaranteed to be 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 AbstractFuture.cancel(boolean).
        Overrides:
        setException in class AbstractFuture<V>
        Parameters:
        throwable - the exception to be used as the failed result
        Returns:
        true if the attempt was accepted, completing the Future
      • setFuture

        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 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 AbstractFuture.cancel(boolean).

        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 AbstractFuture.interruptTask() method, and the AbstractFuture.wasInterrupted() method will not return true.

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