Class Futures
- java.lang.Object
-
- com.google.common.util.concurrent.Futures
-
@Beta @GwtCompatible(emulated=true) public final class Futures extends java.lang.Object
Static utility methods pertaining to theFutureinterface.Many of these methods use the
ListenableFutureAPI; consult the Guava User Guide article onListenableFuture.- Since:
- 1.0
- Author:
- Kevin Bourrillion, Nishant Thakkar, Sven Mawson
-
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static <V> voidaddCallback(ListenableFuture<V> future, FutureCallback<? super V> callback)Registers separate success and failure callbacks to be run when theFuture's computation is complete or, if the computation is already complete, immediately.static <V> voidaddCallback(ListenableFuture<V> future, FutureCallback<? super V> callback, java.util.concurrent.Executor executor)Registers separate success and failure callbacks to be run when theFuture's computation is complete or, if the computation is already complete, immediately.static <V> ListenableFuture<java.util.List<V>>allAsList(ListenableFuture<? extends V>... futures)Creates a newListenableFuturewhose value is a list containing the values of all its input futures, if all succeed.static <V> ListenableFuture<java.util.List<V>>allAsList(java.lang.Iterable<? extends ListenableFuture<? extends V>> futures)Creates a newListenableFuturewhose value is a list containing the values of all its input futures, if all succeed.static <V,X extends java.lang.Throwable>
ListenableFuture<V>catching(ListenableFuture<? extends V> input, java.lang.Class<X> exceptionType, Function<? super X,? extends V> fallback)Returns aFuturewhose result is taken from the given primaryinputor, if the primary input fails with the givenexceptionType, from the result provided by thefallback.static <V,X extends java.lang.Throwable>
ListenableFuture<V>catching(ListenableFuture<? extends V> input, java.lang.Class<X> exceptionType, Function<? super X,? extends V> fallback, java.util.concurrent.Executor executor)Returns aFuturewhose result is taken from the given primaryinputor, if the primary input fails with the givenexceptionType, from the result provided by thefallback.static <V,X extends java.lang.Throwable>
ListenableFuture<V>catchingAsync(ListenableFuture<? extends V> input, java.lang.Class<X> exceptionType, AsyncFunction<? super X,? extends V> fallback)Returns aFuturewhose result is taken from the given primaryinputor, if the primary input fails with the givenexceptionType, from the result provided by thefallback.static <V,X extends java.lang.Throwable>
ListenableFuture<V>catchingAsync(ListenableFuture<? extends V> input, java.lang.Class<X> exceptionType, AsyncFunction<? super X,? extends V> fallback, java.util.concurrent.Executor executor)Returns aFuturewhose result is taken from the given primaryinputor, if the primary input fails with the givenexceptionType, from the result provided by thefallback.static <V> ListenableFuture<V>dereference(ListenableFuture<? extends ListenableFuture<? extends V>> nested)Returns a newListenableFuturewhose result is the product of callingget()on theFuturenested within the givenFuture, effectively chaining the futures one after the other.static <V,X extends java.lang.Exception>
Vget(java.util.concurrent.Future<V> future, long timeout, java.util.concurrent.TimeUnit unit, java.lang.Class<X> exceptionClass)Deprecated.UsegetChecked(Future, Class, long, TimeUnit), noting the change in parameter order.static <V,X extends java.lang.Exception>
Vget(java.util.concurrent.Future<V> future, java.lang.Class<X> exceptionClass)Deprecated.static <V,X extends java.lang.Exception>
VgetChecked(java.util.concurrent.Future<V> future, java.lang.Class<X> exceptionClass)Returns the result ofFuture.get(), converting most exceptions to a new instance of the given checked exception type.static <V,X extends java.lang.Exception>
VgetChecked(java.util.concurrent.Future<V> future, java.lang.Class<X> exceptionClass, long timeout, java.util.concurrent.TimeUnit unit)Returns the result ofFuture.get(long, TimeUnit), converting most exceptions to a new instance of the given checked exception type.static <V> VgetUnchecked(java.util.concurrent.Future<V> future)Returns the result of callingFuture.get()uninterruptibly on a task known not to throw a checked exception.static <V> ListenableFuture<V>immediateCancelledFuture()Creates aListenableFuturewhich is cancelled immediately upon construction, so thatisCancelled()always returnstrue.static <V,X extends java.lang.Exception>
CheckedFuture<V,X>immediateCheckedFuture(V value)Returns aCheckedFuturewhich has its value set immediately upon construction.static <V,X extends java.lang.Exception>
CheckedFuture<V,X>immediateFailedCheckedFuture(X exception)Returns aCheckedFuturewhich has an exception set immediately upon construction.static <V> ListenableFuture<V>immediateFailedFuture(java.lang.Throwable throwable)Returns aListenableFuturewhich has an exception set immediately upon construction.static <V> ListenableFuture<V>immediateFuture(V value)Creates aListenableFuturewhich has its value set immediately upon construction.static <T> ImmutableList<ListenableFuture<T>>inCompletionOrder(java.lang.Iterable<? extends ListenableFuture<? extends T>> futures)Returns a list of delegate futures that correspond to the futures received in the order that they complete.static <I,O>
java.util.concurrent.Future<O>lazyTransform(java.util.concurrent.Future<I> input, Function<? super I,? extends O> function)Liketransform(ListenableFuture, Function)except that the transformationfunctionis invoked on each call toget()on the returned future.static <V,X extends java.lang.Exception>
CheckedFuture<V,X>makeChecked(ListenableFuture<V> future, Function<? super java.lang.Exception,X> mapper)Creates aCheckedFutureout of a normalListenableFutureand aFunctionthat maps fromExceptioninstances into the appropriate checked type.static <V> ListenableFuture<V>nonCancellationPropagating(ListenableFuture<V> future)Creates a newListenableFuturewhose result is set from the supplied future when it completes.static <V> ListenableFuture<java.util.List<V>>successfulAsList(ListenableFuture<? extends V>... futures)Creates a newListenableFuturewhose value is a list containing the values of all its successful input futures.static <V> ListenableFuture<java.util.List<V>>successfulAsList(java.lang.Iterable<? extends ListenableFuture<? extends V>> futures)Creates a newListenableFuturewhose value is a list containing the values of all its successful input futures.static <I,O>
ListenableFuture<O>transform(ListenableFuture<I> input, Function<? super I,? extends O> function)Returns a newListenableFuturewhose result is the product of applying the givenFunctionto the result of the givenFuture.static <I,O>
ListenableFuture<O>transform(ListenableFuture<I> input, Function<? super I,? extends O> function, java.util.concurrent.Executor executor)Returns a newListenableFuturewhose result is the product of applying the givenFunctionto the result of the givenFuture.static <I,O>
ListenableFuture<O>transform(ListenableFuture<I> input, AsyncFunction<? super I,? extends O> function)Deprecated.TheseAsyncFunctionoverloads oftransformare being renamed totransformAsync.static <I,O>
ListenableFuture<O>transform(ListenableFuture<I> input, AsyncFunction<? super I,? extends O> function, java.util.concurrent.Executor executor)Deprecated.TheseAsyncFunctionoverloads oftransformare being renamed totransformAsync.static <I,O>
ListenableFuture<O>transformAsync(ListenableFuture<I> input, AsyncFunction<? super I,? extends O> function)Returns a newListenableFuturewhose result is asynchronously derived from the result of the givenFuture.static <I,O>
ListenableFuture<O>transformAsync(ListenableFuture<I> input, AsyncFunction<? super I,? extends O> function, java.util.concurrent.Executor executor)Returns a newListenableFuturewhose result is asynchronously derived from the result of the givenFuture.static <V> ListenableFuture<V>withFallback(ListenableFuture<? extends V> input, FutureFallback<? extends V> fallback)Deprecated.UsecatchingAsync(input, Throwable.class, fallbackImplementedAsAnAsyncFunction), usually replacingThrowable.classwith the specific type you want to handle.static <V> ListenableFuture<V>withFallback(ListenableFuture<? extends V> input, FutureFallback<? extends V> fallback, java.util.concurrent.Executor executor)Deprecated.UsecatchingAsync(input, Throwable.class, fallbackImplementedAsAnAsyncFunction, executor), usually replacingThrowable.classwith the specific type you want to handle.static <V> ListenableFuture<V>withTimeout(ListenableFuture<V> delegate, long time, java.util.concurrent.TimeUnit unit, java.util.concurrent.ScheduledExecutorService scheduledExecutor)Returns a future that delegates to another but will finish early (via aTimeoutExceptionwrapped in anExecutionException) if the specified duration expires.
-
-
-
Method Detail
-
makeChecked
@GwtIncompatible("TODO") @CheckReturnValue public static <V,X extends java.lang.Exception> CheckedFuture<V,X> makeChecked(ListenableFuture<V> future, Function<? super java.lang.Exception,X> mapper)
Creates aCheckedFutureout of a normalListenableFutureand aFunctionthat maps fromExceptioninstances into the appropriate checked type.Warning: We recommend against using
CheckedFuturein new projects.CheckedFutureis difficult to build libraries atop.CheckedFutureports of methods liketransformAsync(com.google.common.util.concurrent.ListenableFuture<I>, com.google.common.util.concurrent.AsyncFunction<? super I, ? extends O>)have historically had bugs, and some of these bugs are necessary, unavoidable consequences of theCheckedFutureAPI. Additionally,CheckedFutureencourages users to take exceptions from one thread and rethrow them in another, producing confusing stack traces.The given mapping function will be applied to an
InterruptedException, aCancellationException, or anExecutionException. SeeFuture.get()for details on the exceptions thrown.- Since:
- 9.0 (source-compatible since 1.0)
-
immediateFuture
@CheckReturnValue public static <V> ListenableFuture<V> immediateFuture(@Nullable V value)
Creates aListenableFuturewhich has its value set immediately upon construction. The getters just return the value. ThisFuturecan't be canceled or timed out and itsisDone()method always returnstrue.
-
immediateCheckedFuture
@GwtIncompatible("TODO") @CheckReturnValue public static <V,X extends java.lang.Exception> CheckedFuture<V,X> immediateCheckedFuture(@Nullable V value)
Returns aCheckedFuturewhich has its value set immediately upon construction.The returned
Futurecan't be cancelled, and itsisDone()method always returnstrue. Callingget()orcheckedGet()will immediately return the provided value.
-
immediateFailedFuture
@CheckReturnValue public static <V> ListenableFuture<V> immediateFailedFuture(java.lang.Throwable throwable)
Returns aListenableFuturewhich has an exception set immediately upon construction.The returned
Futurecan't be cancelled, and itsisDone()method always returnstrue. Callingget()will immediately throw the providedThrowablewrapped in anExecutionException.
-
immediateCancelledFuture
@GwtIncompatible("TODO") @CheckReturnValue public static <V> ListenableFuture<V> immediateCancelledFuture()
Creates aListenableFuturewhich is cancelled immediately upon construction, so thatisCancelled()always returnstrue.- Since:
- 14.0
-
immediateFailedCheckedFuture
@GwtIncompatible("TODO") @CheckReturnValue public static <V,X extends java.lang.Exception> CheckedFuture<V,X> immediateFailedCheckedFuture(X exception)
Returns aCheckedFuturewhich has an exception set immediately upon construction.The returned
Futurecan't be cancelled, and itsisDone()method always returnstrue. Callingget()will immediately throw the providedExceptionwrapped in anExecutionException, and callingcheckedGet()will throw the provided exception itself.
-
withFallback
@Deprecated @CheckReturnValue public static <V> ListenableFuture<V> withFallback(ListenableFuture<? extends V> input, FutureFallback<? extends V> fallback)
Deprecated.UsecatchingAsync(input, Throwable.class, fallbackImplementedAsAnAsyncFunction), usually replacingThrowable.classwith the specific type you want to handle. This method will be removed in Guava release 20.0.Returns aFuturewhose result is taken from the given primaryinputor, if the primary input fails, from theFutureprovided by thefallback.FutureFallback.create(java.lang.Throwable)is not invoked until the primary input has failed, so if the primary input succeeds, it is never invoked. If, during the invocation offallback, an exception is thrown, this exception is used as the result of the outputFuture.Below is an example of a fallback that returns a default value if an exception occurs:
ListenableFuture<Integer> fetchCounterFuture = ...; // Falling back to a zero counter in case an exception happens when // processing the RPC to fetch counters. ListenableFuture<Integer> faultTolerantFuture = Futures.withFallback( fetchCounterFuture, new FutureFallback<Integer>() { public ListenableFuture<Integer> create(Throwable t) { // Returning "0" as the default for the counter when the // exception happens. return immediateFuture(0); } });The fallback can also choose to propagate the original exception when desired:
ListenableFuture<Integer> fetchCounterFuture = ...; // Falling back to a zero counter only in case the exception was a // TimeoutException. ListenableFuture<Integer> faultTolerantFuture = Futures.withFallback( fetchCounterFuture, new FutureFallback<Integer>() { public ListenableFuture<Integer> create(Throwable t) { if (t instanceof TimeoutException) { return immediateFuture(0); } return immediateFailedFuture(t); } });This overload, which does not accept an executor, uses
directExecutor, a dangerous choice in some cases. See the discussion in theListenableFuture.addListenerdocumentation. The documentation's warnings about "lightweight listeners" refer here to the work done duringFutureFallback.create, not to any work done to complete the returnedFuture.- Parameters:
input- the primary inputFuturefallback- theFutureFallbackimplementation to be called ifinputfails- Since:
- 14.0
-
withFallback
@Deprecated @CheckReturnValue public static <V> ListenableFuture<V> withFallback(ListenableFuture<? extends V> input, FutureFallback<? extends V> fallback, java.util.concurrent.Executor executor)
Deprecated.UsecatchingAsync(input, Throwable.class, fallbackImplementedAsAnAsyncFunction, executor), usually replacingThrowable.classwith the specific type you want to handle. This method will be removed in Guava release 20.0.Returns aFuturewhose result is taken from the given primaryinputor, if the primary input fails, from theFutureprovided by thefallback.FutureFallback.create(java.lang.Throwable)is not invoked until the primary input has failed, so if the primary input succeeds, it is never invoked. If, during the invocation offallback, an exception is thrown, this exception is used as the result of the outputFuture.Below is an example of a fallback that returns a default value if an exception occurs:
ListenableFuture<Integer> fetchCounterFuture = ...; // Falling back to a zero counter in case an exception happens when // processing the RPC to fetch counters. ListenableFuture<Integer> faultTolerantFuture = Futures.withFallback( fetchCounterFuture, new FutureFallback<Integer>() { public ListenableFuture<Integer> create(Throwable t) { // Returning "0" as the default for the counter when the // exception happens. return immediateFuture(0); } }, directExecutor());The fallback can also choose to propagate the original exception when desired:
ListenableFuture<Integer> fetchCounterFuture = ...; // Falling back to a zero counter only in case the exception was a // TimeoutException. ListenableFuture<Integer> faultTolerantFuture = Futures.withFallback( fetchCounterFuture, new FutureFallback<Integer>() { public ListenableFuture<Integer> create(Throwable t) { if (t instanceof TimeoutException) { return immediateFuture(0); } return immediateFailedFuture(t); } }, directExecutor());When selecting an executor, note that
directExecutoris dangerous in some cases. See the discussion in theListenableFuture.addListenerdocumentation. The documentation's warnings about "lightweight listeners" refer here to the work done duringFutureFallback.create, not to any work done to complete the returnedFuture.- Parameters:
input- the primary inputFuturefallback- theFutureFallbackimplementation to be called ifinputfailsexecutor- the executor that runsfallbackifinputfails- Since:
- 14.0
-
catching
@GwtIncompatible("AVAILABLE but requires exceptionType to be Throwable.class") @CheckReturnValue public static <V,X extends java.lang.Throwable> ListenableFuture<V> catching(ListenableFuture<? extends V> input, java.lang.Class<X> exceptionType, Function<? super X,? extends V> fallback)
Returns aFuturewhose result is taken from the given primaryinputor, if the primary input fails with the givenexceptionType, from the result provided by thefallback.Function.apply(F)is not invoked until the primary input has failed, so if the primary input succeeds, it is never invoked. If, during the invocation offallback, an exception is thrown, this exception is used as the result of the outputFuture.Usage example:
ListenableFuture<Integer> fetchCounterFuture = ...; // Falling back to a zero counter in case an exception happens when // processing the RPC to fetch counters. ListenableFuture<Integer> faultTolerantFuture = Futures.catching( fetchCounterFuture, FetchException.class, new Function<FetchException, Integer>() { public Integer apply(FetchException e) { return 0; } });This overload, which does not accept an executor, uses
directExecutor, a dangerous choice in some cases. See the discussion in theListenableFuture.addListenerdocumentation. The documentation's warnings about "lightweight listeners" refer here to the work done duringFunction.apply.- Parameters:
input- the primary inputFutureexceptionType- the exception type that triggers use offallback. To avoid hiding bugs and other unrecoverable errors, callers should prefer more specific types, avoidingThrowable.classin particular.fallback- theFunctionimplementation to be called ifinputfails with the expected exception type- Since:
- 19.0
-
catching
@GwtIncompatible("AVAILABLE but requires exceptionType to be Throwable.class") @CheckReturnValue public static <V,X extends java.lang.Throwable> ListenableFuture<V> catching(ListenableFuture<? extends V> input, java.lang.Class<X> exceptionType, Function<? super X,? extends V> fallback, java.util.concurrent.Executor executor)
Returns aFuturewhose result is taken from the given primaryinputor, if the primary input fails with the givenexceptionType, from the result provided by thefallback.Function.apply(F)is not invoked until the primary input has failed, so if the primary input succeeds, it is never invoked. If, during the invocation offallback, an exception is thrown, this exception is used as the result of the outputFuture.Usage example:
ListenableFuture<Integer> fetchCounterFuture = ...; // Falling back to a zero counter in case an exception happens when // processing the RPC to fetch counters. ListenableFuture<Integer> faultTolerantFuture = Futures.catching( fetchCounterFuture, FetchException.class, new Function<FetchException, Integer>() { public Integer apply(FetchException e) { return 0; } }, directExecutor());When selecting an executor, note that
directExecutoris dangerous in some cases. See the discussion in theListenableFuture.addListenerdocumentation. The documentation's warnings about "lightweight listeners" refer here to the work done duringFunction.apply.- Parameters:
input- the primary inputFutureexceptionType- the exception type that triggers use offallback. To avoid hiding bugs and other unrecoverable errors, callers should prefer more specific types, avoidingThrowable.classin particular.fallback- theFunctionimplementation to be called ifinputfails with the expected exception typeexecutor- the executor that runsfallbackifinputfails- Since:
- 19.0
-
catchingAsync
@GwtIncompatible("AVAILABLE but requires exceptionType to be Throwable.class") public static <V,X extends java.lang.Throwable> ListenableFuture<V> catchingAsync(ListenableFuture<? extends V> input, java.lang.Class<X> exceptionType, AsyncFunction<? super X,? extends V> fallback)
Returns aFuturewhose result is taken from the given primaryinputor, if the primary input fails with the givenexceptionType, from the result provided by thefallback.AsyncFunction.apply(I)is not invoked until the primary input has failed, so if the primary input succeeds, it is never invoked. If, during the invocation offallback, an exception is thrown, this exception is used as the result of the outputFuture.Usage examples:
ListenableFuture<Integer> fetchCounterFuture = ...; // Falling back to a zero counter in case an exception happens when // processing the RPC to fetch counters. ListenableFuture<Integer> faultTolerantFuture = Futures.catchingAsync( fetchCounterFuture, FetchException.class, new AsyncFunction<FetchException, Integer>() { public ListenableFuture<Integer> apply(FetchException e) { return immediateFuture(0); } });The fallback can also choose to propagate the original exception when desired:
ListenableFuture<Integer> fetchCounterFuture = ...; // Falling back to a zero counter only in case the exception was a // TimeoutException. ListenableFuture<Integer> faultTolerantFuture = Futures.catchingAsync( fetchCounterFuture, FetchException.class, new AsyncFunction<FetchException, Integer>() { public ListenableFuture<Integer> apply(FetchException e) throws FetchException { if (omitDataOnFetchFailure) { return immediateFuture(0); } throw e; } });This overload, which does not accept an executor, uses
directExecutor, a dangerous choice in some cases. See the discussion in theListenableFuture.addListenerdocumentation. The documentation's warnings about "lightweight listeners" refer here to the work done duringAsyncFunction.apply, not to any work done to complete the returnedFuture.- Parameters:
input- the primary inputFutureexceptionType- the exception type that triggers use offallback. To avoid hiding bugs and other unrecoverable errors, callers should prefer more specific types, avoidingThrowable.classin particular.fallback- theAsyncFunctionimplementation to be called ifinputfails with the expected exception type- Since:
- 19.0 (similar functionality in 14.0 as
withFallback)
-
catchingAsync
@GwtIncompatible("AVAILABLE but requires exceptionType to be Throwable.class") public static <V,X extends java.lang.Throwable> ListenableFuture<V> catchingAsync(ListenableFuture<? extends V> input, java.lang.Class<X> exceptionType, AsyncFunction<? super X,? extends V> fallback, java.util.concurrent.Executor executor)
Returns aFuturewhose result is taken from the given primaryinputor, if the primary input fails with the givenexceptionType, from the result provided by thefallback.AsyncFunction.apply(I)is not invoked until the primary input has failed, so if the primary input succeeds, it is never invoked. If, during the invocation offallback, an exception is thrown, this exception is used as the result of the outputFuture.Usage examples:
ListenableFuture<Integer> fetchCounterFuture = ...; // Falling back to a zero counter in case an exception happens when // processing the RPC to fetch counters. ListenableFuture<Integer> faultTolerantFuture = Futures.catchingAsync( fetchCounterFuture, FetchException.class, new AsyncFunction<FetchException, Integer>() { public ListenableFuture<Integer> apply(FetchException e) { return immediateFuture(0); } }, directExecutor());The fallback can also choose to propagate the original exception when desired:
ListenableFuture<Integer> fetchCounterFuture = ...; // Falling back to a zero counter only in case the exception was a // TimeoutException. ListenableFuture<Integer> faultTolerantFuture = Futures.catchingAsync( fetchCounterFuture, FetchException.class, new AsyncFunction<FetchException, Integer>() { public ListenableFuture<Integer> apply(FetchException e) throws FetchException { if (omitDataOnFetchFailure) { return immediateFuture(0); } throw e; } }, directExecutor());When selecting an executor, note that
directExecutoris dangerous in some cases. See the discussion in theListenableFuture.addListenerdocumentation. The documentation's warnings about "lightweight listeners" refer here to the work done duringAsyncFunction.apply, not to any work done to complete the returnedFuture.- Parameters:
input- the primary inputFutureexceptionType- the exception type that triggers use offallback. To avoid hiding bugs and other unrecoverable errors, callers should prefer more specific types, avoidingThrowable.classin particular.fallback- theAsyncFunctionimplementation to be called ifinputfails with the expected exception typeexecutor- the executor that runsfallbackifinputfails- Since:
- 19.0 (similar functionality in 14.0 as
withFallback)
-
withTimeout
@GwtIncompatible("java.util.concurrent.ScheduledExecutorService") @CheckReturnValue public static <V> ListenableFuture<V> withTimeout(ListenableFuture<V> delegate, long time, java.util.concurrent.TimeUnit unit, java.util.concurrent.ScheduledExecutorService scheduledExecutor)
Returns a future that delegates to another but will finish early (via aTimeoutExceptionwrapped in anExecutionException) if the specified duration expires.The delegate future is interrupted and cancelled if it times out.
- Parameters:
delegate- The future to delegate to.time- when to timeout the futureunit- the time unit of the time parameterscheduledExecutor- The executor service to enforce the timeout.- Since:
- 19.0
-
transform
@Deprecated public static <I,O> ListenableFuture<O> transform(ListenableFuture<I> input, AsyncFunction<? super I,? extends O> function)
Deprecated.TheseAsyncFunctionoverloads oftransformare being renamed totransformAsync. (TheFunctionoverloads are keeping the "transform" name.) This method will be removed in Guava release 20.0.Returns a newListenableFuturewhose result is asynchronously derived from the result of the givenFuture. More precisely, the returnedFuturetakes its result from aFutureproduced by applying the givenAsyncFunctionto the result of the originalFuture. 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);This overload, which does not accept an executor, uses
directExecutor, a dangerous choice in some cases. See the discussion in theListenableFuture.addListenerdocumentation. The documentation's warnings about "lightweight listeners" refer here to the work done duringAsyncFunction.apply, not to any work done to complete the returnedFuture.The returned
Futureattempts 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 returnedFutureis cancelled, it will attempt to cancel the other two, and if either of the other two is cancelled, the returnedFuturewill receive a callback in which it will attempt to cancel itself.- Parameters:
input- The future to transformfunction- 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
-
transform
@Deprecated public static <I,O> ListenableFuture<O> transform(ListenableFuture<I> input, AsyncFunction<? super I,? extends O> function, java.util.concurrent.Executor executor)
Deprecated.TheseAsyncFunctionoverloads oftransformare being renamed totransformAsync. (TheFunctionoverloads are keeping the "transform" name.) This method will be removed in Guava release 20.0.Returns a newListenableFuturewhose result is asynchronously derived from the result of the givenFuture. More precisely, the returnedFuturetakes its result from aFutureproduced by applying the givenAsyncFunctionto the result of the originalFuture. 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);When selecting an executor, note that
directExecutoris dangerous in some cases. See the discussion in theListenableFuture.addListenerdocumentation. The documentation's warnings about "lightweight listeners" refer here to the work done duringAsyncFunction.apply, not to any work done to complete the returnedFuture.The returned
Futureattempts 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 returnedFutureis cancelled, it will attempt to cancel the other two, and if either of the other two is cancelled, the returnedFuturewill receive a callback in which it will attempt to cancel itself.- Parameters:
input- The future to transformfunction- A function to transform the result of the input future to the result of the output futureexecutor- 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
-
transformAsync
public static <I,O> ListenableFuture<O> transformAsync(ListenableFuture<I> input, AsyncFunction<? super I,? extends O> function)
Returns a newListenableFuturewhose result is asynchronously derived from the result of the givenFuture. More precisely, the returnedFuturetakes its result from aFutureproduced by applying the givenAsyncFunctionto the result of the originalFuture. 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 = transformAsync(rowKeyFuture, queryFunction);This overload, which does not accept an executor, uses
directExecutor, a dangerous choice in some cases. See the discussion in theListenableFuture.addListenerdocumentation. The documentation's warnings about "lightweight listeners" refer here to the work done duringAsyncFunction.apply, not to any work done to complete the returnedFuture.The returned
Futureattempts 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 returnedFutureis cancelled, it will attempt to cancel the other two, and if either of the other two is cancelled, the returnedFuturewill receive a callback in which it will attempt to cancel itself.- Parameters:
input- The future to transformfunction- 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:
- 19.0 (in 11.0 as
transform)
-
transformAsync
public static <I,O> ListenableFuture<O> transformAsync(ListenableFuture<I> input, AsyncFunction<? super I,? extends O> function, java.util.concurrent.Executor executor)
Returns a newListenableFuturewhose result is asynchronously derived from the result of the givenFuture. More precisely, the returnedFuturetakes its result from aFutureproduced by applying the givenAsyncFunctionto the result of the originalFuture. 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 = transformAsync(rowKeyFuture, queryFunction, executor);When selecting an executor, note that
directExecutoris dangerous in some cases. See the discussion in theListenableFuture.addListenerdocumentation. The documentation's warnings about "lightweight listeners" refer here to the work done duringAsyncFunction.apply, not to any work done to complete the returnedFuture.The returned
Futureattempts 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 returnedFutureis cancelled, it will attempt to cancel the other two, and if either of the other two is cancelled, the returnedFuturewill receive a callback in which it will attempt to cancel itself.- Parameters:
input- The future to transformfunction- A function to transform the result of the input future to the result of the output futureexecutor- 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:
- 19.0 (in 11.0 as
transform)
-
transform
public static <I,O> ListenableFuture<O> transform(ListenableFuture<I> input, Function<? super I,? extends O> function)
Returns a newListenableFuturewhose result is the product of applying the givenFunctionto the result of the givenFuture. 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);This overload, which does not accept an executor, uses
directExecutor, a dangerous choice in some cases. See the discussion in theListenableFuture.addListenerdocumentation. The documentation's warnings about "lightweight listeners" refer here to the work done duringFunction.apply.The returned
Futureattempts to keep its cancellation state in sync with that of the input future. That is, if the returnedFutureis cancelled, it will attempt to cancel the input, and if the input is cancelled, the returnedFuturewill 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 transformfunction- 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)
-
transform
public static <I,O> ListenableFuture<O> transform(ListenableFuture<I> input, Function<? super I,? extends O> function, java.util.concurrent.Executor executor)
Returns a newListenableFuturewhose result is the product of applying the givenFunctionto the result of the givenFuture. 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);When selecting an executor, note that
directExecutoris dangerous in some cases. See the discussion in theListenableFuture.addListenerdocumentation. The documentation's warnings about "lightweight listeners" refer here to the work done duringFunction.apply.The returned
Futureattempts to keep its cancellation state in sync with that of the input future. That is, if the returnedFutureis cancelled, it will attempt to cancel the input, and if the input is cancelled, the returnedFuturewill 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 transformfunction- 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)
-
lazyTransform
@GwtIncompatible("TODO") @CheckReturnValue public static <I,O> java.util.concurrent.Future<O> lazyTransform(java.util.concurrent.Future<I> input, Function<? super I,? extends O> function)
Liketransform(ListenableFuture, Function)except that the transformationfunctionis invoked on each call toget()on the returned future.The returned
Futurereflects 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
transformwho don't have aListenableFutureavailable and do not mind repeated, lazy function evaluation.- Parameters:
input- The future to transformfunction- 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
-
dereference
@CheckReturnValue public static <V> ListenableFuture<V> dereference(ListenableFuture<? extends ListenableFuture<? extends V>> nested)
Returns a newListenableFuturewhose result is the product of callingget()on theFuturenested within the givenFuture, 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 returnedFutureattempts to keep its cancellation state in sync with both the inputFutureand the nestedFuture. The transformation is very lightweight and therefore takes place in the same thread (either the thread that calleddereference, or the thread in which the dereferenced future completes).- Parameters:
nested- The nested future to transform.- Returns:
- A future that holds result of the inner future.
- Since:
- 13.0
-
allAsList
@Beta @SafeVarargs @CheckReturnValue public static <V> ListenableFuture<java.util.List<V>> allAsList(ListenableFuture<? extends V>... futures)
Creates a newListenableFuturewhose value is a list containing the values of all its input futures, if all succeed. If any input fails, the returned future fails immediately.The list of results is in the same order as the input list.
Canceling this future will attempt to cancel all the component futures, and 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
-
allAsList
@Beta @CheckReturnValue public static <V> ListenableFuture<java.util.List<V>> allAsList(java.lang.Iterable<? extends ListenableFuture<? extends V>> futures)
Creates a newListenableFuturewhose value is a list containing the values of all its input futures, if all succeed. If any input fails, the returned future fails immediately.The list of results is in the same order as the input list.
Canceling this future will attempt to cancel all the component futures, and 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
-
nonCancellationPropagating
@GwtIncompatible("TODO") @CheckReturnValue public static <V> ListenableFuture<V> nonCancellationPropagating(ListenableFuture<V> future)
Creates a newListenableFuturewhose result is set from the supplied future when it completes. Cancelling the supplied future will also cancel the returned future, but cancelling the returned future will have no effect on the supplied future.- Since:
- 15.0
-
successfulAsList
@Beta @SafeVarargs @CheckReturnValue public static <V> ListenableFuture<java.util.List<V>> successfulAsList(ListenableFuture<? extends V>... futures)
Creates a newListenableFuturewhose 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 containnull(which is indistinguishable from the future having a successful value ofnull).Canceling this future will attempt to cancel all the component futures.
- Parameters:
futures- futures to combine- Returns:
- a future that provides a list of the results of the component futures
- Since:
- 10.0
-
successfulAsList
@Beta @CheckReturnValue public static <V> ListenableFuture<java.util.List<V>> successfulAsList(java.lang.Iterable<? extends ListenableFuture<? extends V>> futures)
Creates a newListenableFuturewhose 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 containnull(which is indistinguishable from the future having a successful value ofnull).Canceling this future will attempt to cancel all the component futures.
- Parameters:
futures- futures to combine- Returns:
- a future that provides a list of the results of the component futures
- Since:
- 10.0
-
inCompletionOrder
@Beta @GwtIncompatible("TODO") @CheckReturnValue public static <T> ImmutableList<ListenableFuture<T>> inCompletionOrder(java.lang.Iterable<? extends ListenableFuture<? extends T>> futures)
Returns a list of delegate futures that correspond to the futures received in the order that they complete. Delegate futures return the same value or throw the same exception as the corresponding input future returns/throws.Cancelling a delegate future has no effect on any input future, since the delegate future does not correspond to a specific input future until the appropriate number of input futures have completed. At that point, it is too late to cancel the input future. The input future's result, which cannot be stored into the cancelled delegate future, is ignored.
- Since:
- 17.0
-
addCallback
public static <V> void addCallback(ListenableFuture<V> future, FutureCallback<? super V> callback)
Registers separate success and failure callbacks to be run when theFuture'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); } });This overload, which does not accept an executor, uses
directExecutor, a dangerous choice in some cases. See the discussion in theListenableFuture.addListenerdocumentation.For a more general interface to attach a completion listener to a
Future, seeaddListener.- Parameters:
future- The future attach the callback to.callback- The callback to invoke whenfutureis completed.- Since:
- 10.0
-
addCallback
public static <V> void addCallback(ListenableFuture<V> future, FutureCallback<? super V> callback, java.util.concurrent.Executor executor)
Registers separate success and failure callbacks to be run when theFuture'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, new FutureCallback<QueryResult> { public void onSuccess(QueryResult result) { storeInCache(result); } public void onFailure(Throwable t) { reportError(t); } }, e);When selecting an executor, note that
directExecutoris dangerous in some cases. See the discussion in theListenableFuture.addListenerdocumentation.For a more general interface to attach a completion listener to a
Future, seeaddListener.- Parameters:
future- The future attach the callback to.callback- The callback to invoke whenfutureis completed.executor- The executor to runcallbackwhen the future completes.- Since:
- 10.0
-
get
@Deprecated @GwtIncompatible("reflection") public static <V,X extends java.lang.Exception> V get(java.util.concurrent.Future<V> future, java.lang.Class<X> exceptionClass) throws X extends java.lang.Exception
Deprecated.UsegetChecked(Future, Class). This method will be removed in Guava release 20.0.Returns the result ofFuture.get(), converting most exceptions to a new instance of the given checked exception type. This reduces boilerplate for a common use ofFuturein which it is unnecessary to programmatically distinguish between exception types or to extract other information from the exception instance.Exceptions from
Future.getare treated as follows:- Any
ExecutionExceptionhas its cause wrapped in anXif the cause is a checked exception, anUncheckedExecutionExceptionif the cause is aRuntimeException, or anExecutionErrorif the cause is anError. - Any
InterruptedExceptionis wrapped in anX(after restoring the interrupt). - Any
CancellationExceptionis propagated untouched, as is any otherRuntimeException(thoughgetimplementations are discouraged from throwing such exceptions).
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
ExecutionExceptionis wrapped in order to ensure that the new stack trace matches that of the current thread.Instances of
exceptionClassare created by choosing an arbitrary public constructor that accepts zero or more arguments, all of typeStringorThrowable(preferring constructors with at least oneString) and calling the constructor via reflection. If the exception did not already have a cause, one is set by callingThrowable.initCause(Throwable)on it. If no such constructor exists, anIllegalArgumentExceptionis thrown.- Throws:
X- ifgetthrows any checked exception except for anExecutionExceptionwhose cause is not itself a checked exceptionUncheckedExecutionException- ifgetthrows anExecutionExceptionwith aRuntimeExceptionas its causeExecutionError- ifgetthrows anExecutionExceptionwith anErroras its causejava.util.concurrent.CancellationException- ifgetthrows aCancellationExceptionjava.lang.IllegalArgumentException- ifexceptionClassextendsRuntimeExceptionor does not have a suitable constructorX extends java.lang.Exception- Since:
- 10.0
- Any
-
get
@Deprecated @GwtIncompatible("reflection") public static <V,X extends java.lang.Exception> V get(java.util.concurrent.Future<V> future, long timeout, java.util.concurrent.TimeUnit unit, java.lang.Class<X> exceptionClass) throws X extends java.lang.Exception
Deprecated.UsegetChecked(Future, Class, long, TimeUnit), noting the change in parameter order. This method will be removed in Guava release 20.0.Returns the result ofFuture.get(long, TimeUnit), converting most exceptions to a new instance of the given checked exception type. This reduces boilerplate for a common use ofFuturein which it is unnecessary to programmatically distinguish between exception types or to extract other information from the exception instance.Exceptions from
Future.getare treated as follows:- Any
ExecutionExceptionhas its cause wrapped in anXif the cause is a checked exception, anUncheckedExecutionExceptionif the cause is aRuntimeException, or anExecutionErrorif the cause is anError. - Any
InterruptedExceptionis wrapped in anX(after restoring the interrupt). - Any
TimeoutExceptionis wrapped in anX. - Any
CancellationExceptionis propagated untouched, as is any otherRuntimeException(thoughgetimplementations are discouraged from throwing such exceptions).
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
ExecutionExceptionis wrapped in order to ensure that the new stack trace matches that of the current thread.Instances of
exceptionClassare created by choosing an arbitrary public constructor that accepts zero or more arguments, all of typeStringorThrowable(preferring constructors with at least oneString) and calling the constructor via reflection. If the exception did not already have a cause, one is set by callingThrowable.initCause(Throwable)on it. If no such constructor exists, anIllegalArgumentExceptionis thrown.- Throws:
X- ifgetthrows any checked exception except for anExecutionExceptionwhose cause is not itself a checked exceptionUncheckedExecutionException- ifgetthrows anExecutionExceptionwith aRuntimeExceptionas its causeExecutionError- ifgetthrows anExecutionExceptionwith anErroras its causejava.util.concurrent.CancellationException- ifgetthrows aCancellationExceptionjava.lang.IllegalArgumentException- ifexceptionClassextendsRuntimeExceptionor does not have a suitable constructorX extends java.lang.Exception- Since:
- 10.0
- Any
-
getChecked
@GwtIncompatible("reflection") public static <V,X extends java.lang.Exception> V getChecked(java.util.concurrent.Future<V> future, java.lang.Class<X> exceptionClass) throws X extends java.lang.Exception
Returns the result ofFuture.get(), converting most exceptions to a new instance of the given checked exception type. This reduces boilerplate for a common use ofFuturein which it is unnecessary to programmatically distinguish between exception types or to extract other information from the exception instance.Exceptions from
Future.getare treated as follows:- Any
ExecutionExceptionhas its cause wrapped in anXif the cause is a checked exception, anUncheckedExecutionExceptionif the cause is aRuntimeException, or anExecutionErrorif the cause is anError. - Any
InterruptedExceptionis wrapped in anX(after restoring the interrupt). - Any
CancellationExceptionis propagated untouched, as is any otherRuntimeException(thoughgetimplementations are discouraged from throwing such exceptions).
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
ExecutionExceptionis wrapped in order to ensure that the new stack trace matches that of the current thread.Instances of
exceptionClassare created by choosing an arbitrary public constructor that accepts zero or more arguments, all of typeStringorThrowable(preferring constructors with at least oneString) and calling the constructor via reflection. If the exception did not already have a cause, one is set by callingThrowable.initCause(Throwable)on it. If no such constructor exists, anIllegalArgumentExceptionis thrown.- Throws:
X- ifgetthrows any checked exception except for anExecutionExceptionwhose cause is not itself a checked exceptionUncheckedExecutionException- ifgetthrows anExecutionExceptionwith aRuntimeExceptionas its causeExecutionError- ifgetthrows anExecutionExceptionwith anErroras its causejava.util.concurrent.CancellationException- ifgetthrows aCancellationExceptionjava.lang.IllegalArgumentException- ifexceptionClassextendsRuntimeExceptionor does not have a suitable constructorX extends java.lang.Exception- Since:
- 19.0 (in 10.0 as
get)
- Any
-
getChecked
@GwtIncompatible("reflection") public static <V,X extends java.lang.Exception> V getChecked(java.util.concurrent.Future<V> future, java.lang.Class<X> exceptionClass, long timeout, java.util.concurrent.TimeUnit unit) throws X extends java.lang.Exception
Returns the result ofFuture.get(long, TimeUnit), converting most exceptions to a new instance of the given checked exception type. This reduces boilerplate for a common use ofFuturein which it is unnecessary to programmatically distinguish between exception types or to extract other information from the exception instance.Exceptions from
Future.getare treated as follows:- Any
ExecutionExceptionhas its cause wrapped in anXif the cause is a checked exception, anUncheckedExecutionExceptionif the cause is aRuntimeException, or anExecutionErrorif the cause is anError. - Any
InterruptedExceptionis wrapped in anX(after restoring the interrupt). - Any
TimeoutExceptionis wrapped in anX. - Any
CancellationExceptionis propagated untouched, as is any otherRuntimeException(thoughgetimplementations are discouraged from throwing such exceptions).
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
ExecutionExceptionis wrapped in order to ensure that the new stack trace matches that of the current thread.Instances of
exceptionClassare created by choosing an arbitrary public constructor that accepts zero or more arguments, all of typeStringorThrowable(preferring constructors with at least oneString) and calling the constructor via reflection. If the exception did not already have a cause, one is set by callingThrowable.initCause(Throwable)on it. If no such constructor exists, anIllegalArgumentExceptionis thrown.- Throws:
X- ifgetthrows any checked exception except for anExecutionExceptionwhose cause is not itself a checked exceptionUncheckedExecutionException- ifgetthrows anExecutionExceptionwith aRuntimeExceptionas its causeExecutionError- ifgetthrows anExecutionExceptionwith anErroras its causejava.util.concurrent.CancellationException- ifgetthrows aCancellationExceptionjava.lang.IllegalArgumentException- ifexceptionClassextendsRuntimeExceptionor does not have a suitable constructorX extends java.lang.Exception- Since:
- 19.0 (in 10.0 as
getand with different parameter order)
- Any
-
getUnchecked
@GwtIncompatible("TODO") public static <V> V getUnchecked(java.util.concurrent.Future<V> future)
Returns the result of callingFuture.get()uninterruptibly on a task known not to throw a checked exception. This makesFuturemore suitable for lightweight, fast-running tasks that, barring bugs in the code, will not fail. This gives it exception-handling behavior similar to that ofForkJoinTask.join.Exceptions from
Future.getare treated as follows:- Any
ExecutionExceptionhas its cause wrapped in anUncheckedExecutionException(if the cause is anException) orExecutionError(if the cause is anError). - Any
InterruptedExceptioncauses a retry of thegetcall. The interrupt is restored beforegetUncheckedreturns. - Any
CancellationExceptionis propagated untouched. So is any otherRuntimeException(getimplementations are discouraged from throwing such exceptions).
The overall principle is to eliminate all checked exceptions: to loop to avoid
InterruptedException, to pass throughCancellationException, and to wrap any exception from the underlying computation in anUncheckedExecutionExceptionorExecutionError.For an uninterruptible
getthat preserves other exceptions, seeUninterruptibles.getUninterruptibly(Future).- Throws:
UncheckedExecutionException- ifgetthrows anExecutionExceptionwith anExceptionas its causeExecutionError- ifgetthrows anExecutionExceptionwith anErroras its causejava.util.concurrent.CancellationException- ifgetthrows aCancellationException- Since:
- 10.0
- Any
-
-