org.infinispan.commons.api.functional

Enum Param.FutureMode

java.lang.Object

java.lang.Enum<Param.FutureMode>

org.infinispan.commons.api.functional.Param.FutureMode

All Implemented Interfaces:

Serializable, Comparable<Param.FutureMode>, Param<Param.FutureMode>

Enclosing interface:

Param<P>

public static enum Param.FutureMode
extends Enum<Param.FutureMode>
implements Param<Param.FutureMode>

When a method defines CompletableFuture as a return type, it implies the method called will be called asynchronously and that the CompletableFuture returned will be completed once the method's work is complete.

So, calling a method that returns CompletableFuture normally implies that the method will allocate a thread to do that job. However, there are situations when the user calls a method that returns CompletableFuture and immediately calls CompletableFuture.get() or similar methods to get the result. Calling such methods result in the caller thread blocking in which case, having such method spawn another thread is a waste of resources. So, for such situations, the caller can pass in the COMPLETED param so that the internal logic avoids creating a separate thread, since the caller thread will block to get the result immediately.

By default, all methods returning CompletableFuture are asynchronous, hence using the ASYNC future mode.

Since:

8.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.infinispan.commons.api.functional.Param

Param.FutureMode, Param.PersistenceMode

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASYNC
COMPLETED

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID

Method Summary

Modifier and Type	Method and Description
static Param.FutureMode	defaultValue() Provides default future mode.
Param.FutureMode	get() Parameter's value.
int	id() A parameter's identifier.
static Param.FutureMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static Param.FutureMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ASYNC

public static final Param.FutureMode ASYNC

COMPLETED

public static final Param.FutureMode COMPLETED

Field Detail

ID

public static final int ID

See Also:

Constant Field Values

Method Detail

values

public static Param.FutureMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Param.FutureMode c : Param.FutureMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static Param.FutureMode 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

id

public int id()

Description copied from interface: Param

A parameter's identifier. Each parameter must have a different id.

A numeric id makes it flexible enough to be stored in collections that take up low resources, such as arrays.

Specified by:

id in interface Param<Param.FutureMode>

get

public Param.FutureMode get()

Description copied from interface: Param

Parameter's value.

Specified by:

get in interface Param<Param.FutureMode>

defaultValue

public static Param.FutureMode defaultValue()

Provides default future mode.