Modifier and Type	Class and Description
public static class	Promise.Adapter< the type of the result U> Empty implementation of `Promise`.
public static class	Promise.Completable< the type of the result S> A CompletableFuture that is also a Promise.
public static class	Promise.Wrapper<W>

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

Method Summary

Modifier and Type	Method and Description
public default void	completeWith(CompletableFuture<C> the CompletableFuture that completes this promise completable) Completes this promise with the given `CompletableFuture`.
public default void	failed(Throwable the reason for the operation failure x) Callback invoked when the operation fails.
public static < the type of the result T> Promise<T>	Returns: a new Promise wrapping the success and failure consumers. from(Consumer<T> the consumer invoked when the promise is succeeded success, Consumer<Throwable> the consumer invoked when the promise is failed failure) Creates a Promise from the given success and failure consumers.
public static < the type of the result T> Promise<T>	Returns: a promise that when completed, completes the given CompletableFuture from(CompletableFuture<? super T> the CompletableFuture to convert into a promise completable) Creates a promise from the given incomplete CompletableFuture.
public static <T> Promise<T>	noop()
public default void	succeeded(C the context result) Callback invoked when the operation completes.

Field Detail

NOOP	back to summary
public static final Promise<Object> NOOP

Method Detail

completeWith back to summary

completeWith	back to summary
public 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:CompletableFuture<C> the CompletableFuture that completes this promise

public 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:CompletableFuture<C>: the CompletableFuture that completes this promise

failed	back to summary
public default void failed(Throwable x) Callback invoked when the operation fails. Parameters x:Throwable the reason for the operation failure

failed

back to summary

public default void failed(Throwable x)

Callback invoked when the operation fails.

Parameters

x:Throwable: the reason for the operation failure

from	back to summary
public static <T> Promise<T> from(Consumer<T> success, Consumer<Throwable> failure) Creates a Promise from the given success and failure consumers. Parameters <T> the type of the result success:Consumer<T> the consumer invoked when the promise is succeeded failure:Consumer<Throwable> the consumer invoked when the promise is failed Returns:Promise<T> a new Promise wrapping the success and failure consumers.

from

back to summary

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

Creates a Promise from the given success and failure consumers.

Parameters

<T>: the type of the result
success:Consumer<T>: the consumer invoked when the promise is succeeded
failure:Consumer<Throwable>: the consumer invoked when the promise is failed

Returns:Promise<T>

a new Promise wrapping the success and failure consumers.

from back to summary

from	back to summary
public 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)`. Parameters <T> the type of the result completable:CompletableFuture<? super T> the CompletableFuture to convert into a promise Returns:Promise<T> a promise that when completed, completes the given CompletableFuture

public 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).

Parameters

<T>: the type of the result
completable:CompletableFuture<? super T>: the CompletableFuture to convert into a promise

Returns:Promise<T>

a promise that when completed, completes the given CompletableFuture

noop	back to summary
public static <T> Promise<T> noop() Annotations @SuppressWarnings:unchecked

succeeded back to summary

succeeded	back to summary
public default void succeeded(C result) Callback invoked when the operation completes. Parameters result:C the context See Also `failed(Throwable)`

public default void succeeded(C result)

Callback invoked when the operation completes.

Parameters

result:C: the context

See Also

failed(Throwable)

org.eclipse.jetty.util back to summary

public Class Promise.Adapter<U>

Class Inheritance

extends Object
implements Promise<U>

java.lang.Object
org.eclipse.jetty.util.Promise.Adapter

All Implemented Interfaces

org.eclipse.jetty.util.Promise

Type Parameters

<U>: the type of the result

Empty implementation of Promise.

Constructor Summary

Access	Constructor and Description
public	Adapter()

Method Summary

Modifier and Type	Method and Description
public void	failed(Throwable the reason for the operation failure x) Overrides default org.eclipse.jetty.util.Promise.failed. Callback invoked when the operation fails.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

Adapter	back to summary
public Adapter()

Method Detail

failed	back to summary
public void failed(Throwable x) Overrides default org.eclipse.jetty.util.Promise.failed. Doc from org.eclipse.jetty.util.Promise.failed. Callback invoked when the operation fails. Parameters x:Throwable the reason for the operation failure Annotations @Override

failed

back to summary

public void failed(Throwable x)

Overrides default org.eclipse.jetty.util.Promise.failed.

Doc from org.eclipse.jetty.util.Promise.failed.

Callback invoked when the operation fails.

Parameters

x:Throwable: the reason for the operation failure

Annotations

@Override

org.eclipse.jetty.util back to summary

public Class Promise.Completable<S>

Class Inheritance

extends CompletableFuture<S>
implements Promise<S>

java.lang.Object
java.util.concurrent.CompletableFuture
org.eclipse.jetty.util.Promise.Completable

All Implemented Interfaces

org.eclipse.jetty.util.Promise

Type Parameters

<S>: the type of the result

A CompletableFuture that is also a Promise.

Constructor Summary

Access	Constructor and Description
public	Completable()

Method Summary

Modifier and Type	Method and Description
public void	failed(Throwable the reason for the operation failure x) Overrides default org.eclipse.jetty.util.Promise.failed. Callback invoked when the operation fails.
public void	succeeded(S the context result) Overrides default org.eclipse.jetty.util.Promise.succeeded. Callback invoked when the operation completes.
public static < the type of the result R> Promise.Completable<R>	Returns: the newly created `Completable` with(Consumer<Promise<R>> the code that consumes the newly created `Completable` consumer) Creates a new `Completable` to be consumed by the given `consumer`, then returns the newly created `Completable`.

Inherited from java.util.concurrent.CompletableFuture:: acceptEither acceptEitherAsync acceptEitherAsync allOf anyOf applyToEither applyToEitherAsync applyToEitherAsync cancel complete completeAsync completeAsync completedFuture completedStage completeExceptionally completeOnTimeout copy defaultExecutor delayedExecutor delayedExecutor exceptionally exceptionallyAsync exceptionallyAsync exceptionallyCompose exceptionallyComposeAsync exceptionallyComposeAsync exceptionNow failedFuture failedStage get get getNow getNumberOfDependents handle handleAsync handleAsync isCancelled isCompletedExceptionally isDone join minimalCompletionStage newIncompleteFuture obtrudeException obtrudeValue orTimeout resultNow runAfterBoth runAfterBothAsync runAfterBothAsync runAfterEither runAfterEitherAsync runAfterEitherAsync runAsync runAsync state supplyAsync supplyAsync thenAccept thenAcceptAsync thenAcceptAsync thenAcceptBoth thenAcceptBothAsync thenAcceptBothAsync thenApply thenApplyAsync thenApplyAsync thenCombine thenCombineAsync thenCombineAsync thenCompose thenComposeAsync thenComposeAsync thenRun thenRunAsync thenRunAsync toCompletableFuture toString whenComplete whenCompleteAsync whenCompleteAsync

Constructor Detail

Completable	back to summary
public Completable()

Method Detail

failed	back to summary
public void failed(Throwable x) Overrides default org.eclipse.jetty.util.Promise.failed. Doc from org.eclipse.jetty.util.Promise.failed. Callback invoked when the operation fails. Parameters x:Throwable the reason for the operation failure Annotations @Override

failed

back to summary

public void failed(Throwable x)

Overrides default org.eclipse.jetty.util.Promise.failed.

Doc from org.eclipse.jetty.util.Promise.failed.

Callback invoked when the operation fails.

Parameters

x:Throwable: the reason for the operation failure

Annotations

@Override

succeeded	back to summary
public void succeeded(S result) Overrides default org.eclipse.jetty.util.Promise.succeeded. Doc from org.eclipse.jetty.util.Promise.succeeded. Callback invoked when the operation completes. Parameters result:S the context Annotations @Override

succeeded

back to summary

public void succeeded(S result)

Overrides default org.eclipse.jetty.util.Promise.succeeded.

Doc from org.eclipse.jetty.util.Promise.succeeded.

Callback invoked when the operation completes.

Parameters

result:S: the context

Annotations

@Override

with back to summary

with	back to summary
public static <R> Promise.Completable<R> with(Consumer<Promise<R>> consumer) Creates a new `Completable` to be consumed by the given `consumer`, then returns the newly created `Completable`. Parameters <R> the type of the result consumer:Consumer<Promise<R>> the code that consumes the newly created `Completable` Returns:Promise.Completable<R> the newly created `Completable`

public static <R> Promise.Completable<R> with(Consumer<Promise<R>> consumer)

Creates a new Completable to be consumed by the given consumer, then returns the newly created Completable.

Parameters

<R>: the type of the result
consumer:Consumer<Promise<R>>: the code that consumes the newly created Completable

Returns:Promise.Completable<R>

the newly created Completable

public Interface Promise<C>

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public Class Promise.Adapter<U>

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Class Promise.Completable<S>

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public Class Promise.Wrapper<W>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public void	failed(Throwable the reason for the operation failure x) Overrides default org.eclipse.jetty.util.Promise.failed. Callback invoked when the operation fails.
public Promise<W>	getPromise()
public void	succeeded(W the context result) Overrides default org.eclipse.jetty.util.Promise.succeeded. Callback invoked when the operation completes.
public Promise<W>	unwrap()