Enum Class CompletableFutures

java.lang.Object

java.lang.Enum<CompletableFutures>

org.jgroups.util.CompletableFutures

All Implemented Interfaces:

Serializable, Comparable<CompletableFutures>, Constable

public enum CompletableFutures
extends Enum<CompletableFutures>

Utility class with CompletableFuture and CompletionStage useful methods.

Since:

5.2

Author:

Pedro Ruivo

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
static CompletableFuture<Boolean>	completedFalse()
static <T> CompletableFuture<T>	completedNull()	A null completed CompletableFuture.
static CompletableFuture<Boolean>	completedTrue()
static <T> T	join(CompletableFuture<T> cf)	Waits for the CompletableFuture to complete.
static <T> T	join(CompletionStage<T> cs)	Same as join(CompletableFuture) but it receives a CompletionStage as parameter.
static <T> Function<T,Void>	toVoidFunction()
static CompletableFutures	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CompletableFutures[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
static <T> Consumer<T>	voidConsumer()	Consumes any value and return a Void.
static CompletionException	wrapAsCompletionException(Throwable throwable)	Wraps the throwable into CompletionException.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final CompletableFutures INSTANCE

Method Details

values

public static CompletableFutures[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CompletableFutures valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

join

public static <T> T join(CompletionStage<T> cs)

Same as join(CompletableFuture) but it receives a CompletionStage as parameter.

See Also:

• join(CompletableFuture)

join

public static <T> T join(CompletableFuture<T> cf)

Waits for the CompletableFuture to complete.

Any non RuntimeException thrown is converted to a RuntimeException.

Type Parameters:

T - The value type.

Parameters:

cf - The CompletableFuture

Returns:

The value of the completed CompletableFuture.

completedNull

public static <T> CompletableFuture<T> completedNull()

A null completed CompletableFuture.

Type Parameters:

T - The value type.

Returns:

The CompletableFuture.

voidConsumer

public static <T> Consumer<T> voidConsumer()

Consumes any value and return a Void.

Type Parameters:

T - The value type.

Returns:

The Consumer.

wrapAsCompletionException

public static CompletionException wrapAsCompletionException(Throwable throwable)

Wraps the throwable into CompletionException.

Parameters:

throwable - The Throwable to wrap.

Returns:

The CompletionException with throwable.

toVoidFunction

public static <T> Function<T,Void> toVoidFunction()

Type Parameters:

T - The value's type.

Returns:

A Function that converts any value to Void.

completedTrue

public static CompletableFuture<Boolean> completedTrue()

Returns:

A CompletableFuture completed with value Boolean.TRUE

completedFalse

public static CompletableFuture<Boolean> completedFalse()

Returns:

A CompletableFuture completed with value Boolean.FALSE