org.eclipse.milo.opcua.stack.core.util

Class FutureUtils

java.lang.Object

org.eclipse.milo.opcua.stack.core.util.FutureUtils

public class FutureUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FutureUtils.CompletionBuilder<T>

Constructor Summary

Constructors

Constructor and Description
FutureUtils()

Method Summary

Modifier and Type	Method and Description
static <T> FutureUtils.CompletionBuilder<T>	complete(CompletableFuture<T> future) Complete future with the result of the CompletableFuture that is provided to the returned FutureUtils.CompletionBuilder.
static <T> FutureUtils.CompletionBuilder<T>	completeAsync(CompletableFuture<T> future, Executor executor) Complete future asynchronously with the result of the CompletableFuture that is provided to the returned FutureUtils.CompletionBuilder.
static <T> CompletableFuture<T>	failedFuture(Throwable ex) Return a CompletableFuture that has been completed exceptionally using the provided Throwable.
static <T> CompletableFuture<T>	failedUaFuture(long statusCode) Return a CompletableFuture that has been completed exceptionally with a UaException built from statusCode.
static <T> CompletableFuture<T>	failedUaFuture(StatusCode statusCode) Return a CompletableFuture that has been completed exceptionally with a UaException built from statusCode.
static <T> CompletableFuture<T>	failedUaFuture(Throwable cause, long statusCode) Return a CompletableFuture that has been completed exceptionally with a UaException built from statusCode.
static <T> CompletableFuture<List<T>>	flatSequence(List<CompletableFuture<List<T>>> futures) Flatten a List of future Lists into a CompletableFuture of List
static <T> CompletableFuture<List<T>>	sequence(CompletableFuture<T>... futures)
static <T> CompletableFuture<List<T>>	sequence(List<CompletableFuture<T>> futures)
static <T> CompletableFuture<List<T>>	sequence(Stream<CompletableFuture<T>> stream)
static <T> CompletableFuture<T>	unwrap(CompletableFuture<CompletableFuture<T>> future) Unwrap a CompletableFuture of CompletableFuture of T into a CompletableFuture of T.

Methods inherited from class java.lang.Object

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

Constructor Detail

FutureUtils

public FutureUtils()

Method Detail

sequence

public static <T> CompletableFuture<List<T>> sequence(Stream<CompletableFuture<T>> stream)

sequence

public static <T> CompletableFuture<List<T>> sequence(List<CompletableFuture<T>> futures)

sequence

public static <T> CompletableFuture<List<T>> sequence(CompletableFuture<T>... futures)

failedFuture

public static <T> CompletableFuture<T> failedFuture(Throwable ex)

Return a CompletableFuture that has been completed exceptionally using the provided Throwable.

Parameters:

ex - the Throwable to complete with.

Returns:

a CompletableFuture that has been completed exceptionally using the provided Throwable.

failedUaFuture

public static <T> CompletableFuture<T> failedUaFuture(long statusCode)

Return a CompletableFuture that has been completed exceptionally with a UaException built from statusCode.

Parameters:

statusCode - the status code to build the UaException with.

Returns:

a CompletableFuture that has been completed exceptionally with a UaException built from statusCode.

failedUaFuture

public static <T> CompletableFuture<T> failedUaFuture(StatusCode statusCode)

Return a CompletableFuture that has been completed exceptionally with a UaException built from statusCode.

Parameters:

statusCode - the StatusCode to build the UaException with.

Returns:

a CompletableFuture that has been completed exceptionally with a UaException built from statusCode.

failedUaFuture

public static <T> CompletableFuture<T> failedUaFuture(Throwable cause,
                                                      long statusCode)

Return a CompletableFuture that has been completed exceptionally with a UaException built from statusCode.

Parameters:

cause - the inner Exception.

statusCode - the status code to build the UaException with.

Returns:

a CompletableFuture that has been completed exceptionally with a UaException built from statusCode.

complete

public static <T> FutureUtils.CompletionBuilder<T> complete(CompletableFuture<T> future)

Complete future with the result of the CompletableFuture that is provided to the returned FutureUtils.CompletionBuilder.

Parameters:

future - the future to complete.

Returns:

a FutureUtils.CompletionBuilder.

completeAsync

public static <T> FutureUtils.CompletionBuilder<T> completeAsync(CompletableFuture<T> future,
                                                                 Executor executor)

Complete future asynchronously with the result of the CompletableFuture that is provided to the returned FutureUtils.CompletionBuilder.

Parameters:

future - the future to complete.

executor - the Executor to use.

Returns:

a FutureUtils.CompletionBuilder.

flatSequence

public static <T> CompletableFuture<List<T>> flatSequence(List<CompletableFuture<List<T>>> futures)

Flatten a List of future Lists into a CompletableFuture of List

Type Parameters:

T - the type of item the List holds

Parameters:

futures - a List of future Lists

Returns:

a flattened CompletableFuture of List.

unwrap

public static <T> CompletableFuture<T> unwrap(CompletableFuture<CompletableFuture<T>> future)

Unwrap a CompletableFuture of CompletableFuture of T into a CompletableFuture of T.

Parameters:

future - a CompletableFuture of CompletableFuture of T.

Returns:

an unwrapped CompletableFuture of T.