Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   /*
    * Copyright (C) 2006 The Guava Authors
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    * http://www.apache.org/licenses/LICENSE-2.0
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package com.google.common.util.concurrent;
  
  import static com.google.common.base.Preconditions.checkArgument;
  import static com.google.common.base.Preconditions.checkNotNull;
  import static com.google.common.base.Preconditions.checkState;
  import static com.google.common.util.concurrent.MoreExecutors.sameThreadExecutor;
  import static com.google.common.util.concurrent.Uninterruptibles.getUninterruptibly;
  import static com.google.common.util.concurrent.Uninterruptibles.putUninterruptibly;
  import static com.google.common.util.concurrent.Uninterruptibles.takeUninterruptibly;
  import static java.lang.Thread.currentThread;
  import static java.util.Arrays.asList;
  
  
  import java.util.Arrays;
  import java.util.List;
  
Static utility methods pertaining to the java.util.concurrent.Future interface.

Many of these methods use the ListenableFuture API; consult the Guava User Guide article on ListenableFuture.

Author(s):
Kevin Bourrillion
Nishant Thakkar
Sven Mawson
Since:
1.0
  
  @Beta
  public final class Futures {
    private Futures() {}

  
Creates a CheckedFuture out of a normal ListenableFuture and a com.google.common.base.Function that maps from java.lang.Exception instances into the appropriate checked type.

The given mapping function will be applied to an java.lang.InterruptedException, a java.util.concurrent.CancellationException, or an java.util.concurrent.ExecutionException with the actual cause of the exception. See java.util.concurrent.Future.get() for details on the exceptions thrown.

Since:
9.0 (source-compatible since 1.0)
  
    public static <V, X extends ExceptionCheckedFuture<V, X> makeChecked(
        ListenableFuture<V> futureFunction<Exception, X> mapper) {
      return new MappingCheckedFuture<V, X>(checkNotNull(future), mapper);
    }

  
Creates a ListenableFuture which has its value set immediately upon construction. The getters just return the value. This Future can't be canceled or timed out and its isDone() method always returns true.
  
    public static <V> ListenableFuture<V> immediateFuture(@Nullable V value) {
      SettableFuture<V> future = SettableFuture.create();
      future.set(value);
      return future;
    }

  
Returns a CheckedFuture which has its value set immediately upon construction.

The returned Future can't be cancelled, and its isDone() method always returns true. Calling get() or checkedGet() will immediately return the provided value.

 
   public static <V, X extends ExceptionCheckedFuture<V, X>
       immediateCheckedFuture(@Nullable V value) {
     SettableFuture<V> future = SettableFuture.create();
     future.set(value);
     return Futures.makeChecked(futurenew Function<Exception, X>() {
       @Override
       public X apply(Exception e) {
         throw new AssertionError("impossible");
       }
     });
   }

  
Returns a ListenableFuture which has an exception set immediately upon construction.

The returned Future can't be cancelled, and its isDone() method always returns true. Calling get() will immediately throw the provided Throwable wrapped in an ExecutionException.

Throws:
java.lang.Error if the throwable is an java.lang.Error.
 
   public static <V> ListenableFuture<V> immediateFailedFuture(
       Throwable throwable) {
     checkNotNull(throwable);
     SettableFuture<V> future = SettableFuture.create();
     future.setException(throwable);
     return future;
   }

  
Returns a CheckedFuture which has an exception set immediately upon construction.

The returned Future can't be cancelled, and its isDone() method always returns true. Calling get() will immediately throw the provided Throwable wrapped in an ExecutionException, and calling checkedGet() will throw the provided exception itself.

Throws:
java.lang.Error if the throwable is an java.lang.Error.
 
   public static <V, X extends ExceptionCheckedFuture<V, X>
       immediateFailedCheckedFuture(final X exception) {
     checkNotNull(exception);
     return makeChecked(Futures.<V>immediateFailedFuture(exception),
         new Function<Exception, X>() {
           @Override
           public X apply(Exception e) {
             return exception;
           }
         });
   }

  
Returns a new ListenableFuture whose result is asynchronously derived from the result of the given Future. More precisely, the returned Future takes its result from a Future produced by applying the given AsyncFunction to the result of the original Future. Example:
   ListenableFuture<RowKey> rowKeyFuture = indexService.lookUp(query);
   AsyncFunction<RowKey, QueryResult> queryFunction =
       new AsyncFunction<RowKey, QueryResult>() {
         public ListenableFuture<QueryResult> apply(RowKey rowKey) {
           return dataService.read(rowKey);
         
       };
   ListenableFuture<QueryResult> queryFuture =
       transform(rowKeyFuture, queryFunction);
 }
Note: If the derived Future is slow or heavyweight to create (whether the Future itself is slow or heavyweight to complete is irrelevant), consider supplying an executor. If you do not supply an executor, transform will use MoreExecutors.sameThreadExecutor(), which carries some caveats for heavier operations. For example, the call to function.apply may run on an unpredictable or undesirable thread:
  • If the input Future is done at the time transform is called, transform will call function.apply inline.
  • If the input Future is not yet done, transform will schedule function.apply to be run by the thread that completes the input Future, which may be an internal system thread such as an RPC network thread.
Also note that, regardless of which thread executes function.apply, all other registered but unexecuted listeners are prevented from running during its execution, even if those listeners are to run in other executors.

The returned Future attempts to keep its cancellation state in sync with that of the input future and that of the future returned by the function. That is, if the returned Future is cancelled, it will attempt to cancel the other two, and if either of the other two is cancelled, the returned Future will receive a callback in which it will attempt to cancel itself.

Parameters:
input The future to transform
function A function to transform the result of the input future to the result of the output future
Returns:
A future that holds result of the function (if the input succeeded) or the original input's failure (if not)
Since:
11.0
 
   public static <I, O> ListenableFuture<O> transform(ListenableFuture<I> input,
       AsyncFunction<? super I, ? extends O> function) {
     return transform(inputfunction, MoreExecutors.sameThreadExecutor());
   }

  
Returns a new ListenableFuture whose result is asynchronously derived from the result of the given Future. More precisely, the returned Future takes its result from a Future produced by applying the given AsyncFunction to the result of the original Future. Example:
   ListenableFuture<RowKey> rowKeyFuture = indexService.lookUp(query);
   AsyncFunction<RowKey, QueryResult> queryFunction =
       new AsyncFunction<RowKey, QueryResult>() {
         public ListenableFuture<QueryResult> apply(RowKey rowKey) {
           return dataService.read(rowKey);
         
       };
   ListenableFuture<QueryResult> queryFuture =
       transform(rowKeyFuture, queryFunction, executor);
 }

The returned Future attempts to keep its cancellation state in sync with that of the input future and that of the future returned by the chain function. That is, if the returned Future is cancelled, it will attempt to cancel the other two, and if either of the other two is cancelled, the returned Future will receive a callback in which it will attempt to cancel itself.

When the execution of function.apply is fast and lightweight (though the Future it returns need not meet these criteria), consider omitting the executor or explicitly specifying sameThreadExecutor. However, be aware of the caveats documented in the link above.

Parameters:
input The future to transform
function A function to transform the result of the input future to the result of the output future
executor Executor to run the function in.
Returns:
A future that holds result of the function (if the input succeeded) or the original input's failure (if not)
Since:
11.0
 
   public static <I, O> ListenableFuture<O> transform(ListenableFuture<I> input,
       AsyncFunction<? super I, ? extends O> function,
       Executor executor) {
     ChainingListenableFuture<I, O> output =
         new ChainingListenableFuture<I, O>(functioninput);
     input.addListener(outputexecutor);
     return output;
   }

  
Returns a new ListenableFuture whose result is the product of applying the given Function to the result of the given Future. Example:
   ListenableFuture<QueryResult> queryFuture = ...;
   Function<QueryResult, List<Row>> rowsFunction =
       new Function<QueryResult, List<Row>>() {
         public List<Row> apply(QueryResult queryResult) {
           return queryResult.getRows();
         
       };
   ListenableFuture<List<Row>> rowsFuture =
       transform(queryFuture, rowsFunction);
 }
Note: If the transformation is slow or heavyweight, consider transform(com.google.common.util.concurrent.ListenableFuture,com.google.common.base.Function,java.util.concurrent.Executor). If you do not supply an executor, transform will use MoreExecutors.sameThreadExecutor(), which carries some caveats for heavier operations. For example, the call to function.apply may run on an unpredictable or undesirable thread:
  • If the input Future is done at the time transform is called, transform will call function.apply inline.
  • If the input Future is not yet done, transform will schedule function.apply to be run by the thread that completes the input Future, which may be an internal system thread such as an RPC network thread.
Also note that, regardless of which thread executes function.apply, all other registered but unexecuted listeners are prevented from running during its execution, even if those listeners are to run in other executors.

The returned Future attempts to keep its cancellation state in sync with that of the input future. That is, if the returned Future is cancelled, it will attempt to cancel the input, and if the input is cancelled, the returned Future will receive a callback in which it will attempt to cancel itself.

An example use of this method is to convert a serializable object returned from an RPC into a POJO.

Parameters:
input The future to transform
function A Function to transform the results of the provided future to the results of the returned future. This will be run in the thread that notifies input it is complete.
Returns:
A future that holds result of the transformation.
Since:
9.0 (in 1.0 as compose)
 
   public static <I, O> ListenableFuture<O> transform(ListenableFuture<I> input,
       final Function<? super I, ? extends O> function) {
     return transform(inputfunction, MoreExecutors.sameThreadExecutor());
   }

  
Returns a new ListenableFuture whose result is the product of applying the given Function to the result of the given Future. Example:
   ListenableFuture<QueryResult> queryFuture = ...;
   Function<QueryResult, List<Row>> rowsFunction =
       new Function<QueryResult, List<Row>>() {
         public List<Row> apply(QueryResult queryResult) {
           return queryResult.getRows();
         
       };
   ListenableFuture<List<Row>> rowsFuture =
       transform(queryFuture, rowsFunction, executor);
 }

The returned Future attempts to keep its cancellation state in sync with that of the input future. That is, if the returned Future is cancelled, it will attempt to cancel the input, and if the input is cancelled, the returned Future will receive a callback in which it will attempt to cancel itself.

An example use of this method is to convert a serializable object returned from an RPC into a POJO.

When the transformation is fast and lightweight, consider transform(com.google.common.util.concurrent.ListenableFuture,com.google.common.base.Function) or explicitly specifying sameThreadExecutor. However, be aware of the caveats documented in the link above.

Parameters:
input The future to transform
function A Function to transform the results of the provided future to the results of the returned future.
executor Executor to run the function in.
Returns:
A future that holds result of the transformation.
Since:
9.0 (in 2.0 as compose)
 
   public static <I, O> ListenableFuture<O> transform(ListenableFuture<I> input,
       final Function<? super I, ? extends O> functionExecutor executor) {
     checkNotNull(function);
     AsyncFunction<I, O> wrapperFunction
         = new AsyncFunction<I, O>() {
             @Override public ListenableFuture<O> apply(I input) {
               O output = function.apply(input);
               return immediateFuture(output);
             }
         };
     return transform(inputwrapperFunctionexecutor);
   }

  
Like transform(com.google.common.util.concurrent.ListenableFuture,com.google.common.base.Function) except that the transformation function is invoked on each call to get() on the returned future.

The returned Future reflects the input's cancellation state directly, and any attempt to cancel the returned Future is likewise passed through to the input Future.

Note that calls to timed get only apply the timeout to the execution of the underlying Future, not to the execution of the transformation function.

The primary audience of this method is callers of transform who don't have a ListenableFuture available and do not mind repeated, lazy function evaluation.

Parameters:
input The future to transform
function A Function to transform the results of the provided future to the results of the returned future.
Returns:
A future that returns the result of the transformation.
Since:
10.0
 
   @Beta
   public static <I, O> Future<O> lazyTransform(final Future<I> input,
       final Function<? super I, ? extends O> function) {
     checkNotNull(input);
     checkNotNull(function);
     return new Future<O>() {
 
       @Override
       public boolean cancel(boolean mayInterruptIfRunning) {
         return input.cancel(mayInterruptIfRunning);
       }
 
       @Override
       public boolean isCancelled() {
         return input.isCancelled();
       }
 
       @Override
       public boolean isDone() {
         return input.isDone();
       }
 
       @Override
       public O get() throws InterruptedExceptionExecutionException {
         return applyTransformation(input.get());
       }
 
       @Override
       public O get(long timeoutTimeUnit unit)
           throws InterruptedExceptionExecutionExceptionTimeoutException {
         return applyTransformation(input.get(timeoutunit));
       }
 
       private O applyTransformation(I inputthrows ExecutionException {
         try {
           return function.apply(input);
         } catch (Throwable t) {
           throw new ExecutionException(t);
         }
       }
     };
   }

  
An implementation of ListenableFuture that also implements Runnable so that it can be used to nest ListenableFutures. Once the passed-in ListenableFuture is complete, it calls the passed-in Function to generate the result.

If the function throws any checked exceptions, they should be wrapped in a UndeclaredThrowableException so that this class can get access to the cause.

 
   private static class ChainingListenableFuture<I, O>
       extends AbstractFuture<O> implements Runnable {
 
     private AsyncFunction<? super I, ? extends O> function;
     private ListenableFuture<? extends I> inputFuture;
     private volatile ListenableFuture<? extends O> outputFuture;
         new LinkedBlockingQueue<Boolean>(1);
     private final CountDownLatch outputCreated = new CountDownLatch(1);
 
     private ChainingListenableFuture(
         AsyncFunction<? super I, ? extends O> function,
         ListenableFuture<? extends I> inputFuture) {
       this. = checkNotNull(function);
       this. = checkNotNull(inputFuture);
     }
 
     @Override
     public boolean cancel(boolean mayInterruptIfRunning) {
       /*
        * Our additional cancellation work needs to occur even if
        * !mayInterruptIfRunning, so we can't move it into interruptTask().
        */
       if (super.cancel(mayInterruptIfRunning)) {
         // This should never block since only one thread is allowed to cancel
         // this Future.
         putUninterruptibly(mayInterruptIfRunning);
         cancel(mayInterruptIfRunning);
         cancel(mayInterruptIfRunning);
         return true;
       }
       return false;
     }
 
     private void cancel(@Nullable Future<?> future,
         boolean mayInterruptIfRunning) {
       if (future != null) {
         future.cancel(mayInterruptIfRunning);
       }
     }
 
     @Override
     public void run() {
       try {
         I sourceResult;
         try {
           sourceResult = getUninterruptibly();
         } catch (CancellationException e) {
           // Cancel this future and return.
           // At this point, inputFuture is cancelled and outputFuture doesn't
           // exist, so the value of mayInterruptIfRunning is irrelevant.
           cancel(false);
           return;
         } catch (ExecutionException e) {
           // Set the cause of the exception as this future's exception
           setException(e.getCause());
           return;
         }
 
         final ListenableFuture<? extends O> outputFuture = this. =
             .apply(sourceResult);
         if (isCancelled()) {
           // Handles the case where cancel was called while the function was
           // being applied.
           // There is a gap in cancel(boolean) between calling sync.cancel()
           // and storing the value of mayInterruptIfRunning, so this thread
           // needs to block, waiting for that value.
           outputFuture.cancel(
               takeUninterruptibly());
           this. = null;
           return;
         }
         outputFuture.addListener(new Runnable() {
             @Override
             public void run() {
               try {
                 // Here it would have been nice to have had an
                 // UninterruptibleListenableFuture, but we don't want to start a
                 // combinatorial explosion of interfaces, so we have to make do.
                 set(getUninterruptibly(outputFuture));
               } catch (CancellationException e) {
                 // Cancel this future and return.
                 // At this point, inputFuture and outputFuture are done, so the
                 // value of mayInterruptIfRunning is irrelevant.
                 cancel(false);
                 return;
               } catch (ExecutionException e) {
                 // Set the cause of the exception as this future's exception
                 setException(e.getCause());
               } finally {
                 // Don't pin inputs beyond completion
                 ChainingListenableFuture.this. = null;
               }
             }
           }, MoreExecutors.sameThreadExecutor());
       } catch (UndeclaredThrowableException e) {
         // Set the cause of the exception as this future's exception
         setException(e.getCause());
       } catch (Exception e) {
         // This exception is irrelevant in this thread, but useful for the
         // client
         setException(e);
       } catch (Error e) {
         // Propagate errors up ASAP - our superclass will rethrow the error
         setException(e);
       } finally {
         // Don't pin inputs beyond completion
          = null;
          = null;
         // Allow our get routines to examine outputFuture now.
         .countDown();
       }
     }
   }

  
Returns a new ListenableFuture whose result is the product of calling get() on the Future nested within the given Future, effectively chaining the futures one after the other. Example:
   SettableFuture<ListenableFuture<String>> nested = SettableFuture.create();
   ListenableFuture<String> dereferenced = dereference(nested);
 

This call has the same cancellation and execution semantics as transform(ListenableFuture, AsyncFunction), in that the returned Future attempts to keep its cancellation state in sync with both the input Future and the nested Future. The transformation is very lightweight and therefore takes place in the thread that called dereference.

Parameters:
nested The nested future to transform.
Returns:
A future that holds result of the inner future.
Since:
13.0
 
   @Beta
   @SuppressWarnings({"rawtypes""unchecked"})
   public static <V> ListenableFuture<V> dereference(
       ListenableFuture<? extends ListenableFuture<? extends V>> nested) {
     return Futures.transform((ListenableFuturenested, (AsyncFunction);
   }

  
 
   private static final AsyncFunction<ListenableFuture<Object>, ObjectDEREFERENCER =
       new AsyncFunction<ListenableFuture<Object>, Object>() {
         @Override public ListenableFuture<Objectapply(ListenableFuture<Objectinput) {
           return input;
         }
       };

  
Creates a new ListenableFuture whose value is a list containing the values of all its input futures, if all succeed. If any input fails, the returned future fails.

The list of results is in the same order as the input list.

Canceling this future does not cancel any of the component futures; however, if any of the provided futures fails or is canceled, this one is, too.

Parameters:
futures futures to combine
Returns:
a future that provides a list of the results of the component futures
Since:
10.0
 
   @Beta
   public static <V> ListenableFuture<List<V>> allAsList(
       ListenableFuture<? extends V>... futures) {
     return new ListFuture<V>(ImmutableList.copyOf(futures), true,
         MoreExecutors.sameThreadExecutor());
   }

  
Creates a new ListenableFuture whose value is a list containing the values of all its input futures, if all succeed. If any input fails, the returned future fails.

The list of results is in the same order as the input list.

Canceling this future does not cancel any of the component futures; however, if any of the provided futures fails or is canceled, this one is, too.

Parameters:
futures futures to combine
Returns:
a future that provides a list of the results of the component futures
Since:
10.0
 
   @Beta
   public static <V> ListenableFuture<List<V>> allAsList(
       Iterable<? extends ListenableFuture<? extends V>> futures) {
     return new ListFuture<V>(ImmutableList.copyOf(futures), true,
         MoreExecutors.sameThreadExecutor());
   }

  
Creates a new ListenableFuture whose value is a list containing the values of all its successful input futures. The list of results is in the same order as the input list, and if any of the provided futures fails or is canceled, its corresponding position will contain null (which is indistinguishable from the future having a successful value of null).

Parameters:
futures futures to combine
Returns:
a future that provides a list of the results of the component futures
Since:
10.0
 
   @Beta
   public static <V> ListenableFuture<List<V>> successfulAsList(
       ListenableFuture<? extends V>... futures) {
     return new ListFuture<V>(ImmutableList.copyOf(futures), false,
         MoreExecutors.sameThreadExecutor());
   }

  
Creates a new ListenableFuture whose value is a list containing the values of all its successful input futures. The list of results is in the same order as the input list, and if any of the provided futures fails or is canceled, its corresponding position will contain null (which is indistinguishable from the future having a successful value of null).

Parameters:
futures futures to combine
Returns:
a future that provides a list of the results of the component futures
Since:
10.0
 
   @Beta
   public static <V> ListenableFuture<List<V>> successfulAsList(
       Iterable<? extends ListenableFuture<? extends V>> futures) {
     return new ListFuture<V>(ImmutableList.copyOf(futures), false,
         MoreExecutors.sameThreadExecutor());
   }

  
Registers separate success and failure callbacks to be run when the Future's computation is complete or, if the computation is already complete, immediately.

There is no guaranteed ordering of execution of callbacks, but any callback added through this method is guaranteed to be called once the computation is complete. Example:

 ListenableFuture<QueryResult> future = ...;
 addCallback(future,
     new FutureCallback<QueryResult> {
       public void onSuccess(QueryResult result) {
         storeInCache(result);
       
       public void onFailure(Throwable t) {
         reportError(t);
       }
     });}
Note: If the callback is slow or heavyweight, consider addCallback(com.google.common.util.concurrent.ListenableFuture,com.google.common.util.concurrent.FutureCallback,java.util.concurrent.Executor). If you do not supply an executor, addCallback will use sameThreadExecutor, which carries some caveats for heavier operations. For example, the callback may run on an unpredictable or undesirable thread:
  • If the input Future is done at the time addCallback is called, addCallback will execute the callback inline.
  • If the input Future is not yet done, addCallback will schedule the callback to be run by the thread that completes the input Future, which may be an internal system thread such as an RPC network thread.
Also note that, regardless of which thread executes the callback, all other registered but unexecuted listeners are prevented from running during its execution, even if those listeners are to run in other executors.

For a more general interface to attach a completion listener to a Future, see addListener.

Parameters:
future The future attach the callback to.
callback The callback to invoke when future is completed.
Since:
10.0
 
   public static <V> void addCallback(ListenableFuture<V> future,
       FutureCallback<? super V> callback) {
     addCallback(futurecallback, MoreExecutors.sameThreadExecutor());
   }

  
Registers separate success and failure callbacks to be run when the Future's computation is complete or, if the computation is already complete, immediately.

The callback is run in executor. There is no guaranteed ordering of execution of callbacks, but any callback added through this method is guaranteed to be called once the computation is complete. Example:

 ListenableFuture<QueryResult> future = ...;
 Executor e = ...
 addCallback(future, e,
     new FutureCallback<QueryResult> {
       public void onSuccess(QueryResult result) {
         storeInCache(result);
       
       public void onFailure(Throwable t) {
         reportError(t);
       }
     });}
When the callback is fast and lightweight, consider addCallback(com.google.common.util.concurrent.ListenableFuture,com.google.common.util.concurrent.FutureCallback) or explicitly specifying sameThreadExecutor. However, be aware of the caveats documented in the link above.

For a more general interface to attach a completion listener to a Future, see addListener.

Parameters:
future The future attach the callback to.
callback The callback to invoke when future is completed.
executor The executor to run callback when the future completes.
Since:
10.0
 
   public static <V> void addCallback(final ListenableFuture<V> future,
       final FutureCallback<? super V> callbackExecutor executor) {
     Preconditions.checkNotNull(callback);
     Runnable callbackListener = new Runnable() {
       @Override
       public void run() {
         try {
           // TODO(user): (Before Guava release), validate that this
           // is the thing for IE.
           V value = getUninterruptibly(future);
           callback.onSuccess(value);
         } catch (ExecutionException e) {
           callback.onFailure(e.getCause());
         } catch (RuntimeException e) {
           callback.onFailure(e);
         } catch (Error e) {
           callback.onFailure(e);
         }
       }
     };
     future.addListener(callbackListenerexecutor);
   }

  
Returns the result of java.util.concurrent.Future.get(), converting most exceptions to a new instance of the given checked exception type. This reduces boilerplate for a common use of Future in which it is unnecessary to programmatically distinguish between exception types or to extract other information from the exception instance.

Exceptions from Future.get are treated as follows:

The overall principle is to continue to treat every checked exception as a checked exception, every unchecked exception as an unchecked exception, and every error as an error. In addition, the cause of any ExecutionException is wrapped in order to ensure that the new stack trace matches that of the current thread.

Instances of exceptionClass are created by choosing an arbitrary public constructor that accepts zero or more arguments, all of type String or Throwable (preferring constructors with at least one String) and calling the constructor via reflection. If the exception did not already have a cause, one is set by calling java.lang.Throwable.initCause(java.lang.Throwable) on it. If no such constructor exists, an IllegalArgumentException is thrown.

Throws:
X if get throws any checked exception except for an ExecutionException whose cause is not itself a checked exception
UncheckedExecutionException if get throws an ExecutionException with a RuntimeException as its cause
ExecutionError if get throws an ExecutionException with an Error as its cause
java.util.concurrent.CancellationException if get throws a CancellationException
java.lang.IllegalArgumentException if exceptionClass extends RuntimeException or does not have a suitable constructor
Since:
10.0
 
   @Beta
   public static <V, X extends Exception> V get(
       Future<V> futureClass<X> exceptionClassthrows X {
     checkNotNull(future);
     checkArgument(!RuntimeException.class.isAssignableFrom(exceptionClass),
         "Futures.get exception type (%s) must not be a RuntimeException",
         exceptionClass);
     try {
       return future.get();
     } catch (InterruptedException e) {
       currentThread().interrupt();
       throw newWithCause(exceptionClasse);
     } catch (ExecutionException e) {
       wrapAndThrowExceptionOrError(e.getCause(), exceptionClass);
       throw new AssertionError();
     }
   }

  
Returns the result of java.util.concurrent.Future.get(long,java.util.concurrent.TimeUnit), converting most exceptions to a new instance of the given checked exception type. This reduces boilerplate for a common use of Future in which it is unnecessary to programmatically distinguish between exception types or to extract other information from the exception instance.

Exceptions from Future.get are treated as follows:

The overall principle is to continue to treat every checked exception as a checked exception, every unchecked exception as an unchecked exception, and every error as an error. In addition, the cause of any ExecutionException is wrapped in order to ensure that the new stack trace matches that of the current thread.

Instances of exceptionClass are created by choosing an arbitrary public constructor that accepts zero or more arguments, all of type String or Throwable (preferring constructors with at least one String) and calling the constructor via reflection. If the exception did not already have a cause, one is set by calling java.lang.Throwable.initCause(java.lang.Throwable) on it. If no such constructor exists, an IllegalArgumentException is thrown.

Throws:
X if get throws any checked exception except for an ExecutionException whose cause is not itself a checked exception
UncheckedExecutionException if get throws an ExecutionException with a RuntimeException as its cause
ExecutionError if get throws an ExecutionException with an Error as its cause
java.util.concurrent.CancellationException if get throws a CancellationException
java.lang.IllegalArgumentException if exceptionClass extends RuntimeException or does not have a suitable constructor
Since:
10.0
 
   @Beta
   public static <V, X extends Exception> V get(
       Future<V> futurelong timeoutTimeUnit unitClass<X> exceptionClass)
       throws X {
     checkNotNull(future);
     checkNotNull(unit);
     checkArgument(!RuntimeException.class.isAssignableFrom(exceptionClass),
         "Futures.get exception type (%s) must not be a RuntimeException",
         exceptionClass);
     try {
       return future.get(timeoutunit);
     } catch (InterruptedException e) {
       currentThread().interrupt();
       throw newWithCause(exceptionClasse);
     } catch (TimeoutException e) {
       throw newWithCause(exceptionClasse);
     } catch (ExecutionException e) {
       wrapAndThrowExceptionOrError(e.getCause(), exceptionClass);
       throw new AssertionError();
     }
   }
 
   private static <X extends Exceptionvoid wrapAndThrowExceptionOrError(
       Throwable causeClass<X> exceptionClassthrows X {
     if (cause instanceof Error) {
       throw new ExecutionError((Errorcause);
     }
     if (cause instanceof RuntimeException) {
       throw new UncheckedExecutionException(cause);
     }
     throw newWithCause(exceptionClasscause);
   }

  
Returns the result of calling java.util.concurrent.Future.get() uninterruptibly on a task known not to throw a checked exception. This makes Future more suitable for lightweight, fast-running tasks that, barring bugs in the code, will not fail. This gives it exception-handling behavior similar to that of ForkJoinTask.join.

Exceptions from Future.get are treated as follows:

The overall principle is to eliminate all checked exceptions: to loop to avoid InterruptedException, to pass through CancellationException, and to wrap any exception from the underlying computation in an UncheckedExecutionException or ExecutionError.

For an uninterruptible get that preserves other exceptions, see Uninterruptibles.getUninterruptibly(java.util.concurrent.Future).

Throws:
UncheckedExecutionException if get throws an ExecutionException with an Exception as its cause
ExecutionError if get throws an ExecutionException with an Error as its cause
java.util.concurrent.CancellationException if get throws a CancellationException
Since:
10.0
 
   @Beta
   public static <V> V getUnchecked(Future<V> future) {
     checkNotNull(future);
     try {
       return getUninterruptibly(future);
    } catch (ExecutionException e) {
      throw new AssertionError();
    }
  }
  private static void wrapAndThrowUnchecked(Throwable cause) {
    if (cause instanceof Error) {
      throw new ExecutionError((Errorcause);
    }
    /*
     * It's a non-Error, non-Exception Throwable. From my survey of such
     * classes, I believe that most users intended to extend Exception, so we'll
     * treat it like an Exception.
     */
    throw new UncheckedExecutionException(cause);
  }
  /*
   * TODO(user): FutureChecker interface for these to be static methods on? If
   * so, refer to it in the (static-method) Futures.get documentation
   */
  /*
   * Arguably we don't need a timed getUnchecked because any operation slow
   * enough to require a timeout is heavyweight enough to throw a checked
   * exception and therefore be inappropriate to use with getUnchecked. Further,
   * it's not clear that converting the checked TimeoutException to a
   * RuntimeException -- especially to an UncheckedExecutionException, since it
   * wasn't thrown by the computation -- makes sense, and if we don't convert
   * it, the user still has to write a try-catch block.
   *
   * If you think you would use this method, let us know.
   */
  private static <X extends Exception> X newWithCause(
      Class<X> exceptionClassThrowable cause) {
    // getConstructors() guarantees this as long as we don't modify the array.
    @SuppressWarnings("unchecked")
    List<Constructor<X>> constructors =
        (List) Arrays.asList(exceptionClass.getConstructors());
    for (Constructor<X> constructor : preferringStrings(constructors)) {
      @Nullable X instance = newFromConstructor(constructorcause);
      if (instance != null) {
        if (instance.getCause() == null) {
          instance.initCause(cause);
        }
        return instance;
      }
    }
    throw new IllegalArgumentException(
        "No appropriate constructor for exception of type " + exceptionClass
            + " in response to chained exception"cause);
  }
  private static <X extends ExceptionList<Constructor<X>>
      preferringStrings(List<Constructor<X>> constructors) {
    return .sortedCopy(constructors);
  }
  private static final Ordering<Constructor<?>> WITH_STRING_PARAM_FIRST =
      Ordering.natural().onResultOf(new Function<Constructor<?>, Boolean>() {
        @Override public Boolean apply(Constructor<?> input) {
          return asList(input.getParameterTypes()).contains(String.class);
        }
      }).reverse();
  @Nullable private static <X> X newFromConstructor(
      Constructor<X> constructorThrowable cause) {
    Class<?>[] paramTypes = constructor.getParameterTypes();
    Object[] params = new Object[paramTypes.length];
    for (int i = 0; i < paramTypes.lengthi++) {
      Class<?> paramType = paramTypes[i];
      if (paramType.equals(String.class)) {
        params[i] = cause.toString();
      } else if (paramType.equals(Throwable.class)) {
        params[i] = cause;
      } else {
        return null;
      }
    }
    try {
      return constructor.newInstance(params);
    } catch (IllegalArgumentException e) {
      return null;
    } catch (InstantiationException e) {
      return null;
    } catch (IllegalAccessException e) {
      return null;
    } catch (InvocationTargetException e) {
      return null;
    }
  }

  
Class that implements Futures.allAsList(com.google.common.util.concurrent.ListenableFuture[]) and Futures.successfulAsList(com.google.common.util.concurrent.ListenableFuture[]). The idea is to create a (null-filled) List and register a listener with each component future to fill out the value in the List when that future completes.
  private static class ListFuture<V> extends AbstractFuture<List<V>> {
    ImmutableList<? extends ListenableFuture<? extends V>> futures;
    final boolean allMustSucceed;
    final AtomicInteger remaining;
    List<V> values;

    
Constructor.

Parameters:
futures all the futures to build the list from
allMustSucceed whether a single failure or cancellation should propagate to this future
listenerExecutor used to run listeners on all the passed in futures.
        final ImmutableList<? extends ListenableFuture<? extends V>> futures,
        final boolean allMustSucceedfinal Executor listenerExecutor) {
      this. = futures;
      this. = Lists.newArrayListWithCapacity(futures.size());
      this. = allMustSucceed;
      this. = new AtomicInteger(futures.size());
      init(listenerExecutor);
    }
    private void init(final Executor listenerExecutor) {
      // First, schedule cleanup to execute when the Future is done.
      addListener(new Runnable() {
        @Override
        public void run() {
          // By now the values array has either been set as the Future's value,
          // or (in case of failure) is no longer useful.
          ListFuture.this. = null;
          // Let go of the memory held by other futures
          ListFuture.this. = null;
        }
      }, MoreExecutors.sameThreadExecutor());
      // Now begin the "real" initialization.
      // Corner case: List is empty.
      if (.isEmpty()) {
        set(Lists.newArrayList());
        return;
      }
      // Populate the results list with null initially.
      for (int i = 0; i < .size(); ++i) {
        .add(null);
      }
      // Register a listener on each Future in the list to update
      // the state of this future.
      // Note that if all the futures on the list are done prior to completing
      // this loop, the last call to addListener() will callback to
      // setOneValue(), transitively call our cleanup listener, and set
      // this.futures to null.
      // We store a reference to futures to avoid the NPE.
      ImmutableList<? extends ListenableFuture<? extends V>> localFutures = ;
      for (int i = 0; i < localFutures.size(); i++) {
        final ListenableFuture<? extends V> listenable = localFutures.get(i);
        final int index = i;
        listenable.addListener(new Runnable() {
          @Override
          public void run() {
            setOneValue(indexlistenable);
          }
        }, listenerExecutor);
      }
    }

    
Sets the value at the given index to that of the given future.
    private void setOneValue(int indexFuture<? extends V> future) {
      List<V> localValues = ;
      if (isDone() || localValues == null) {
        // Some other future failed or has been cancelled, causing this one to
        // also be cancelled or have an exception set. This should only happen
        // if allMustSucceed is true.
            "Future was done before all dependencies completed");
        return;
      }
      try {
        checkState(future.isDone(),
            "Tried to set value from future which is not done");
        localValues.set(indexgetUninterruptibly(future));
      } catch (CancellationException e) {
        if () {
          // Set ourselves as cancelled. Let the input futures keep running
          // as some of them may be used elsewhere.
          // (Currently we don't override interruptTask, so
          // mayInterruptIfRunning==false isn't technically necessary.)
          cancel(false);
        }
      } catch (ExecutionException e) {
        if () {
          // As soon as the first one fails, throw the exception up.
          // The result of all other inputs is then ignored.
          setException(e.getCause());
        }
      } catch (RuntimeException e) {
        if () {
          setException(e);
        }
      } catch (Error e) {
        // Propagate errors up ASAP - our superclass will rethrow the error
        setException(e);
      } finally {
        int newRemaining = .decrementAndGet();
        checkState(newRemaining >= 0, "Less than 0 remaining futures");
        if (newRemaining == 0) {
          localValues = ;
          if (localValues != null) {
            set(Lists.newArrayList(localValues));
          } else {
            checkState(isDone());
          }
        }
      }
    }
  }

  
A checked future that uses a function to map from exceptions to the appropriate checked type.
  private static class MappingCheckedFuture<V, X extends Exceptionextends
      AbstractCheckedFuture<V, X> {
    final Function<Exception, X> mapper;
        Function<Exception, X> mapper) {
      super(delegate);
      this. = checkNotNull(mapper);
    }
    @Override
    protected X mapException(Exception e) {
      return .apply(e);
    }
  }
New to GrepCode? Check out our FAQ X