com.facebook.buck.util.concurrent

Class MoreFutures

java.lang.Object

com.facebook.buck.util.concurrent.MoreFutures

public class MoreFutures
extends Object

Method Summary

Modifier and Type	Method and Description
static <V> com.google.common.util.concurrent.ListenableFuture<Unit>	addListenableCallback(com.google.common.util.concurrent.ListenableFuture<V> future, com.google.common.util.concurrent.FutureCallback<? super V> callback, Executor executor) Add a callback to a listenable future
static <U,V> com.google.common.util.concurrent.ListenableFuture<Pair<U,V>>	combinedFutures(com.google.common.util.concurrent.ListenableFuture<U> first, com.google.common.util.concurrent.ListenableFuture<V> second, com.google.common.util.concurrent.ListeningExecutorService executorService) Combine the and listenable futures, returning a listenable future that wraps the result of these futures as a Pair.
static <V> com.google.common.util.concurrent.FutureCallback<V>	finallyCallback(java.util.function.Consumer<com.google.common.util.concurrent.ListenableFuture<V>> callable)
static <V> com.google.common.util.concurrent.FutureCallback<V>	finallyCallback(Runnable runnable)
static <V> List<V>	getAll(com.google.common.util.concurrent.ListeningExecutorService executorService, Iterable<Callable<V>> callables) Invoke multiple callables on the provided executor and wait for all to return successfully.
static Throwable	getFailure(com.google.common.util.concurrent.ListenableFuture<?> future) Returns the failure for a ListenableFuture.
static <V> V	getUncheckedInterruptibly(Future<V> future) Waits for the given future to complete and returns the result.
static boolean	isSuccess(com.google.common.util.concurrent.ListenableFuture<?> future) Create a convenience method for checking whether a future completed successfully because this does not appear to be possible to do in a more direct way: https://groups.google.com/forum/?fromgroups=#!topic/guava-discuss/rofEhagKnOc.
static <X extends Throwable> void	propagateCauseIfInstanceOf(Throwable e, Class<X> type)

Methods inherited from class java.lang.Object

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

Method Detail

combinedFutures

public static <U,V> com.google.common.util.concurrent.ListenableFuture<Pair<U,V>> combinedFutures(com.google.common.util.concurrent.ListenableFuture<U> first,
                                                                                                  com.google.common.util.concurrent.ListenableFuture<V> second,
                                                                                                  com.google.common.util.concurrent.ListeningExecutorService executorService)

Combine the and listenable futures, returning a listenable future that wraps the result of these futures as a Pair.

getAll

public static <V> List<V> getAll(com.google.common.util.concurrent.ListeningExecutorService executorService,
                                 Iterable<Callable<V>> callables)
                          throws ExecutionException,
                                 InterruptedException

Invoke multiple callables on the provided executor and wait for all to return successfully. An exception is thrown (immediately) if any callable fails.

Parameters:

executorService - Executor service.

callables - Callables to call.

Returns:

List of values from each invoked callable in order if all callables execute without throwing.

Throws:

ExecutionException - If any callable throws an exception, the first of such is wrapped in an ExecutionException and thrown. Access via Throwable.getCause()}.

InterruptedException

isSuccess

public static boolean isSuccess(com.google.common.util.concurrent.ListenableFuture<?> future)
                         throws InterruptedException

Create a convenience method for checking whether a future completed successfully because this does not appear to be possible to do in a more direct way: https://groups.google.com/forum/?fromgroups=#!topic/guava-discuss/rofEhagKnOc.

Returns:

true if the specified future has been resolved without throwing an exception or being cancelled.

Throws:

InterruptedException

getFailure

public static Throwable getFailure(com.google.common.util.concurrent.ListenableFuture<?> future)
                            throws InterruptedException

Returns the failure for a ListenableFuture.

Parameters:

future - Must have completed unsuccessfully.

Throws:

InterruptedException

addListenableCallback

public static <V> com.google.common.util.concurrent.ListenableFuture<Unit> addListenableCallback(com.google.common.util.concurrent.ListenableFuture<V> future,
                                                                                                 com.google.common.util.concurrent.FutureCallback<? super V> callback,
                                                                                                 Executor executor)

Add a callback to a listenable future

getUncheckedInterruptibly

public static <V> V getUncheckedInterruptibly(Future<V> future)

Waits for the given future to complete and returns the result. On interrupt, this method throws CancellationException. All exceptions thrown are wrapped with BuckUncheckedExecutionException

Type Parameters:

V - the result type of the Future

Parameters:

future - the Future to wait for

Returns:

the result of the Future when completed

propagateCauseIfInstanceOf

public static <X extends Throwable> void propagateCauseIfInstanceOf(Throwable e,
                                                                    Class<X> type)

finallyCallback

public static <V> com.google.common.util.concurrent.FutureCallback<V> finallyCallback(Runnable runnable)

Returns:

a FutureCallback which executes the given Runnable on both success and error.

finallyCallback

public static <V> com.google.common.util.concurrent.FutureCallback<V> finallyCallback(java.util.function.Consumer<com.google.common.util.concurrent.ListenableFuture<V>> callable)

Returns:

a FutureCallback which executes the given Consumer on both success and error. This just makes it simpler to add unconditional callbacks.