Package org.jgroups.util

Enum CompletableFutures

java.lang.Object

java.lang.Enum<CompletableFutures>

org.jgroups.util.CompletableFutures

All Implemented Interfaces:

Serializable, Comparable<CompletableFutures>, java.lang.constant.Constable

public enum CompletableFutures
extends Enum<CompletableFutures>

Utility class with CompletableFuture and CompletionStage useful methods.

Since:

5.2

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Field Summary

Fields

Modifier and Type	Field	Description
private static final CompletableFuture<Boolean>	FALSE_CF
private static final CompletableFuture<?>	NULL
private static final Function<?,?>	NULL_FUNCTION
private static final CompletableFuture<Boolean>	TRUE_CF
private static final Consumer<?>	VOID_CONSUMER

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CompletableFutures()

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 type with the specified name.
static CompletableFutures[]	values()	Returns an array containing the constants of this enum type, 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 java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INSTANCE

public static final CompletableFutures INSTANCE

Field Details

NULL

private static final CompletableFuture<?> NULL

TRUE_CF

private static final CompletableFuture<Boolean> TRUE_CF

FALSE_CF

private static final CompletableFuture<Boolean> FALSE_CF

VOID_CONSUMER

private static final Consumer<?> VOID_CONSUMER

NULL_FUNCTION

private static final Function<?,?> NULL_FUNCTION

Constructor Details

CompletableFutures

private CompletableFutures()

Method Details

values

public static CompletableFutures[] values()

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

Returns:

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

valueOf

public static CompletableFutures valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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