com.lightbend.cinnamon.java.future

Class NameableCompletableFuture

java.lang.Object

com.lightbend.cinnamon.java.future.NameableCompletableFuture

public class NameableCompletableFuture
extends java.lang.Object

Naming API for CompletableFuture.

Constructor Summary

Constructors

Constructor and Description
NameableCompletableFuture()

Method Summary

Modifier and Type	Method and Description
static <T> java.util.concurrent.CompletableFuture<T>	completedFutureNamed(java.lang.String name, T value) Named version of CompletableFuture.completedFuture(value).
static java.lang.String	currentName() Get the current CompletableFuture / completion name.
static <T> java.util.concurrent.CompletableFuture<T>	disableContext(java.util.concurrent.CompletableFuture<T> future) Disable any Cinnamon attached context on the given CompletableFuture.
static <T> java.util.concurrent.CompletableFuture<T>	newNamed(java.lang.String name) Named version of new CompletableFuture<T>.
static java.util.concurrent.CompletableFuture<java.lang.Void>	runAsyncNamed(java.lang.String name, java.lang.Runnable runnable) Named version of CompletableFuture.runAsync(runnable).
static java.util.concurrent.CompletableFuture<java.lang.Void>	runAsyncNamed(java.lang.String name, java.lang.Runnable runnable, java.util.concurrent.Executor executor) Named version of CompletableFuture.runAsync(runnable, executor).
static <T> java.util.concurrent.CompletableFuture<T>	supplyAsyncNamed(java.lang.String name, java.util.function.Supplier<T> supplier) Named version of CompletableFuture.supplyAsync(supplier).
static <T> java.util.concurrent.CompletableFuture<T>	supplyAsyncNamed(java.lang.String name, java.util.function.Supplier<T> supplier, java.util.concurrent.Executor executor) Named version of CompletableFuture.supplyAsync(supplier, executor).
static <F> F	withName(java.lang.String name, java.util.function.Supplier<F> f) Add a name around CompletableFuture creation or completion callbacks.

Methods inherited from class java.lang.Object

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

Constructor Detail

NameableCompletableFuture

public NameableCompletableFuture()

Method Detail

currentName

public static java.lang.String currentName()

Get the current CompletableFuture / completion name.

Returns:

the current name (thread locally)

withName

public static <F> F withName(java.lang.String name,
                             java.util.function.Supplier<F> f)

Add a name around CompletableFuture creation or completion callbacks.

Type Parameters:

F - the return type of the supplied block

Parameters:

name - the name for the CompletableFuture and/or completion callback

f - the supplied block to name (with newly created CompletableFutures)

Returns:

the result of the supplied block

newNamed

public static <T> java.util.concurrent.CompletableFuture<T> newNamed(java.lang.String name)

Named version of new CompletableFuture<T>.

Type Parameters:

T - the CompletableFuture's type

Parameters:

name - the name for the CompletableFuture

Returns:

the named CompletableFuture

supplyAsyncNamed

public static <T> java.util.concurrent.CompletableFuture<T> supplyAsyncNamed(java.lang.String name,
                                                                             java.util.function.Supplier<T> supplier)

Named version of CompletableFuture.supplyAsync(supplier).

Type Parameters:

T - the function's return type

Parameters:

name - the name for the CompletableFuture

supplier - the supplier for CompletableFuture.supplyAsync

Returns:

the named CompletableFuture

supplyAsyncNamed

public static <T> java.util.concurrent.CompletableFuture<T> supplyAsyncNamed(java.lang.String name,
                                                                             java.util.function.Supplier<T> supplier,
                                                                             java.util.concurrent.Executor executor)

Named version of CompletableFuture.supplyAsync(supplier, executor).

Type Parameters:

T - the function's return type

Parameters:

name - the name for the CompletableFuture

supplier - the supplier for CompletableFuture.supplyAsync

executor - the executor to use for asynchronous execution

Returns:

the named CompletableFuture

runAsyncNamed

public static java.util.concurrent.CompletableFuture<java.lang.Void> runAsyncNamed(java.lang.String name,
                                                                                   java.lang.Runnable runnable)

Named version of CompletableFuture.runAsync(runnable).

Parameters:

name - the name for the CompletableFuture

runnable - the runnable for CompletableFuture.runAsync

Returns:

the named CompletableFuture

runAsyncNamed

public static java.util.concurrent.CompletableFuture<java.lang.Void> runAsyncNamed(java.lang.String name,
                                                                                   java.lang.Runnable runnable,
                                                                                   java.util.concurrent.Executor executor)

Named version of CompletableFuture.runAsync(runnable, executor).

Parameters:

name - the name for the CompletableFuture

runnable - the runnable for CompletableFuture.runAsync

executor - the executor to use for asynchronous execution

Returns:

the named CompletableFuture

completedFutureNamed

public static <T> java.util.concurrent.CompletableFuture<T> completedFutureNamed(java.lang.String name,
                                                                                 T value)

Named version of CompletableFuture.completedFuture(value).

Type Parameters:

T - the type of the value

Parameters:

name - the name for the CompletableFuture

value - the value for CompletableFuture.completedFuture

Returns:

the named and completed CompletableFuture

disableContext

public static <T> java.util.concurrent.CompletableFuture<T> disableContext(java.util.concurrent.CompletableFuture<T> future)

Disable any Cinnamon attached context on the given CompletableFuture.

Can be used if the CompletableFuture will be cached.

Type Parameters:

T - the type of the value

Parameters:

future - the CompletableFuture to disable contexts for

Returns:

the original CompletableFuture with context disabled