Futures (Atomix API Reference (2.1.0-beta1))

java.lang.Object
- io.atomix.utils.concurrent.Futures

```
public final class Futures
extends Object
```
Utilities for creating completed and exceptional futures.

Author:

Jordan Halterman

Constructor Summary

Constructors
Constructor and Description

Futures()

Constructors
Constructor and Description
`Futures()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> CompletableFuture<List<T>>`	`allOf(List<CompletableFuture<T>> futures)` Returns a new CompletableFuture completed with a list of computed values when all of the given CompletableFuture complete.
`static <T> CompletableFuture<T>`	`allOf(List<CompletableFuture<T>> futures, BinaryOperator<T> reducer, T emptyValue)` Returns a new CompletableFuture completed by reducing a list of computed values when all of the given CompletableFuture complete.
`static <T> CompletableFuture<T>`	`asyncFuture(CompletableFuture<T> future, Executor executor)` Returns a wrapped future that will be completed on the given executor.
`static <T> CompletableFuture<T>`	`blockingAwareFuture(CompletableFuture<T> future, Executor executor)` Returns a future that's completed using the given `orderedExecutor` if the future is not blocked or the given `threadPoolExecutor` if the future is blocked.
`static <T> CompletableFuture<T>`	`completedFuture(T result)` Creates a future that is synchronously completed.
`static <T> CompletableFuture<T>`	`completedFutureAsync(T result, Executor executor)` Creates a future that is asynchronously completed.
`static <T> CompletableFuture<T>`	`exceptionalFuture(Throwable t)` Creates a future that is synchronously completed exceptionally.
`static <T> CompletableFuture<T>`	`exceptionalFutureAsync(Throwable t, Executor executor)` Creates a future that is asynchronously completed exceptionally.
`static <T> CompletableFuture<T>`	`firstOf(List<CompletableFuture<T>> futures, Match<T> positiveResultMatcher, T negativeResult)` Returns a new CompletableFuture completed by with the first positive result from a list of input CompletableFutures.
`static <T> CompletableFuture<T>`	`orderedFuture()` Returns a future that completes callbacks in add order.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Futures
```
public Futures()
```
- Method Detail
  - completedFuture
```
public static <T> CompletableFuture<T> completedFuture(T result)
```
    Creates a future that is synchronously completed.
    
    Parameters:
    
    result - The future result.
    
    Returns:
    
    The completed future.
  - completedFutureAsync
```
public static <T> CompletableFuture<T> completedFutureAsync(T result,
                                                            Executor executor)
```
    Creates a future that is asynchronously completed.
    
    Parameters:
    
    result - The future result.
    
    executor - The executor on which to complete the future.
    
    Returns:
    
    The completed future.
  - exceptionalFuture
```
public static <T> CompletableFuture<T> exceptionalFuture(Throwable t)
```
    Creates a future that is synchronously completed exceptionally.
    
    Parameters:
    
    t - The future exception.
    
    Returns:
    
    The exceptionally completed future.
  - exceptionalFutureAsync
```
public static <T> CompletableFuture<T> exceptionalFutureAsync(Throwable t,
                                                              Executor executor)
```
    Creates a future that is asynchronously completed exceptionally.
    
    Parameters:
    
    t - The future exception.
    
    executor - The executor on which to complete the future.
    
    Returns:
    
    The exceptionally completed future.
  - orderedFuture
```
public static <T> CompletableFuture<T> orderedFuture()
```
    Returns a future that completes callbacks in add order.
    
    Type Parameters:
    
    T - future value type
    
    Returns:
    
    a new completable future that will complete added callbacks in the order in which they were added
  - asyncFuture
```
public static <T> CompletableFuture<T> asyncFuture(CompletableFuture<T> future,
                                                   Executor executor)
```
    Returns a wrapped future that will be completed on the given executor.
    
    Type Parameters:
    
    T - the future value type
    
    Parameters:
    
    future - the future to be completed on the given executor
    
    executor - the executor with which to complete the future
    
    Returns:
    
    a wrapped future to be completed on the given executor
  - blockingAwareFuture
```
public static <T> CompletableFuture<T> blockingAwareFuture(CompletableFuture<T> future,
                                                           Executor executor)
```
    Returns a future that's completed using the given orderedExecutor if the future is not blocked or the given threadPoolExecutor if the future is blocked.
    This method allows futures to maintain single-thread semantics via the provided orderedExecutor while ensuring user code can block without blocking completion of futures. When the returned future or any of its descendants is blocked on a CompletableFuture.get() or CompletableFuture.join() call, completion of the returned future will be done using the provided threadPoolExecutor.
    
    Type Parameters:
    
    T - future value type
    
    Parameters:
    
    future - the future to convert into an asynchronous future
    
    executor - the executor with which to attempt to complete the future
    
    Returns:
    
    a new completable future to be completed using the provided executor once the provided future is complete
  - allOf
```
public static <T> CompletableFuture<List<T>> allOf(List<CompletableFuture<T>> futures)
```
    Returns a new CompletableFuture completed with a list of computed values when all of the given CompletableFuture complete.
    
    Type Parameters:
    
    T - value type of CompletableFuture
    
    Parameters:
    
    futures - the CompletableFutures
    
    Returns:
    
    a new CompletableFuture that is completed when all of the given CompletableFutures complete
  - allOf
```
public static <T> CompletableFuture<T> allOf(List<CompletableFuture<T>> futures,
                                             BinaryOperator<T> reducer,
                                             T emptyValue)
```
    Returns a new CompletableFuture completed by reducing a list of computed values when all of the given CompletableFuture complete.
    
    Type Parameters:
    
    T - value type of CompletableFuture
    
    Parameters:
    
    futures - the CompletableFutures
    
    reducer - reducer for computing the result
    
    emptyValue - zero value to be returned if the input future list is empty
    
    Returns:
    
    a new CompletableFuture that is completed when all of the given CompletableFutures complete
  - firstOf
```
public static <T> CompletableFuture<T> firstOf(List<CompletableFuture<T>> futures,
                                               Match<T> positiveResultMatcher,
                                               T negativeResult)
```
    Returns a new CompletableFuture completed by with the first positive result from a list of input CompletableFutures.
    
    Type Parameters:
    
    T - value type of CompletableFuture
    
    Parameters:
    
    futures - the input list of CompletableFutures
    
    positiveResultMatcher - matcher to identify a positive result
    
    negativeResult - value to complete with if none of the futures complete with a positive result
    
    Returns:
    
    a new CompletableFuture

Class Futures

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Futures

Method Detail

completedFuture

completedFutureAsync

exceptionalFuture

exceptionalFutureAsync

orderedFuture

asyncFuture

blockingAwareFuture

allOf

allOf

firstOf