lightbulb_outline Please take our October 2018 developer survey. Start survey

belongs to Maven artifact androidx.concurrent:concurrent-futures:1.0.0-alpha02

ResolvableFuture

public final class ResolvableFuture
extends AbstractResolvableFuture<V>

java.lang.Object
   ↳ androidx.concurrent.futures.AbstractResolvableFuture<V>
     ↳ androidx.concurrent.futures.ResolvableFuture<V>


An AndroidX version of Guava's SettableFuture.

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 cancelled.

If your needs are more complex than ResolvableFuture supports, use AbstractResolvableFuture, which offers an extensible version of the API.

Summary

Public methods

static <V> ResolvableFuture<V> create()

Creates a new ResolvableFuture that can be completed or cancelled by a later method call.

boolean set(V value)

Sets the result of this Future unless this Future has already been cancelled or set (including set asynchronously).

boolean setException(Throwable throwable)

Sets the failed result of this Future unless this Future has already been cancelled or set (including set asynchronously).

boolean setFuture(ListenableFuture<? extends V> future)

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

Inherited methods

Public methods

create

public static ResolvableFuture<V> create ()

Creates a new ResolvableFuture that can be completed or cancelled by a later method call.

Returns
ResolvableFuture<V>

set

public boolean set (V value)

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

Parameters
value V: the value to be used as the result

Returns
boolean true if the attempt was accepted, completing the Future

setException

public boolean setException (Throwable throwable)

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

Parameters
throwable Throwable: the exception to be used as the failed result

Returns
boolean true if the attempt was accepted, completing the Future

setFuture

public boolean setFuture (ListenableFuture<? extends V> future)

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

Parameters
future ListenableFuture: the future to delegate to

Returns
boolean true if the attempt was accepted, indicating that the Future was not previously cancelled or set.