Module org.eclipse.jetty.util

Package org.eclipse.jetty.util

Interface Promise<C>

Type Parameters:

C - the type of the context object

All Known Subinterfaces:

Blocker.Promise<C>, Promise.Invocable<R>

All Known Implementing Classes:

FuturePromise, Promise.Adapter, Promise.Completable, Promise.Task, Promise.Wrapper

public interface Promise<C>

A callback abstraction that handles completed/failed events of asynchronous operations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Promise.Adapter<U>	Empty implementation of Promise.
static class	Promise.Completable<S>	A CompletableFuture that is also a Promise.
static interface	Promise.Invocable<R>	An Invocable Promise that provides the Invocable.InvocationType of calls to succeeded(Object).
static class	Promise.Task<T>	A Promise that implements Runnable to perform a one-shot task that eventually completes this Promise.
static class	Promise.Wrapper<W>

Field Summary

Fields

Modifier and Type	Field	Description
static final Promise<Object>	NOOP

Method Summary

Modifier and Type	Method	Description
default void	completeWith(CompletableFuture<C> completable)	Completes this promise with the given CompletableFuture.
default void	failed(Throwable x)	Callback invoked when the operation fails.
static <T> Promise<T>	from(Runnable complete)	Creates a promise that runs the given Runnable when it succeeds or fails.
static <T> Promise<T>	from(CompletableFuture<? super T> completable)	Creates a promise from the given incomplete CompletableFuture.
static <C> Promise.Invocable<C>	from(Executor executor, Promise<C> promise)	Create an Promise.Invocable that is Invocable.InvocationType.NON_BLOCKING because it executes the callbacks
static <T> Promise<T>	from(Consumer<T> success, Consumer<Throwable> failure)	Creates a Promise from the given success and failure consumers.
static <C> Promise.Invocable<C>	from(Invocable.InvocationType invocationType, Promise<C> promise)	Create an Promise.Invocable
static <T> Promise<T>	noop()
default void	succeeded(C result)	Callback invoked when the operation completes.

Field Details

NOOP

static final Promise<Object> NOOP

Method Details

noop

static <T> Promise<T> noop()

succeeded

default void succeeded(C result)

Callback invoked when the operation completes.

Parameters:

result - the context

See Also:

• failed(Throwable)

failed

default void failed(Throwable x)

Callback invoked when the operation fails.

Parameters:

x - the reason for the operation failure

completeWith

default void completeWith(CompletableFuture<C> completable)

Completes this promise with the given CompletableFuture.

When the CompletableFuture completes normally, this promise is succeeded; when the CompletableFuture completes exceptionally, this promise is failed.

Parameters:

completable - the CompletableFuture that completes this promise

from

static <T> Promise<T> from(Consumer<T> success,
 Consumer<Throwable> failure)

Creates a Promise from the given success and failure consumers.

Type Parameters:

T - the type of the result

Parameters:

success - the consumer invoked when the promise is succeeded

failure - the consumer invoked when the promise is failed

Returns:

a new Promise wrapping the success and failure consumers.

from

static <T> Promise<T> from(CompletableFuture<? super T> completable)

Creates a promise from the given incomplete CompletableFuture.

When the promise completes, either succeeding or failing, the CompletableFuture is also completed, respectively via CompletableFuture.complete(Object) or CompletableFuture.completeExceptionally(Throwable).

Type Parameters:

T - the type of the result

Parameters:

completable - the CompletableFuture to convert into a promise

Returns:

a promise that when completed, completes the given CompletableFuture

from

static <T> Promise<T> from(Runnable complete)

Creates a promise that runs the given Runnable when it succeeds or fails.

Parameters:

complete - The completion task to run on success or failure

Returns:

a new promise

from

static <C> Promise.Invocable<C> from(Invocable.InvocationType invocationType,
 Promise<C> promise)

Create an Promise.Invocable

Type Parameters:

C - The type

Parameters:

invocationType - The Invocable.InvocationType of calls to the Promise.Invocable

promise - The promise on which to delegate calls to.

Returns:

An Invocable Promise.

from

static <C> Promise.Invocable<C> from(Executor executor,
 Promise<C> promise)

Create an Promise.Invocable that is Invocable.InvocationType.NON_BLOCKING because it executes the callbacks

Type Parameters:

C - The type

Parameters:

promise - The promise on which to delegate calls to.

Returns:

An Invocable Promise.