Modifier and Type	Class and Description
public static class	Callback.Completable A `CompletableFuture` that is also a `Callback`.
public static interface	Callback.Completing A Callback implementation that calls the `completed()` method when it either succeeds or fails.
public static class	Callback.Nested Nested Completing Callback that completes after completing the nested callback

Modifier and Type	Field and Description
public static final Callback	NOOP Hides org.eclipse.jetty.util.thread.Invocable.NOOP. Instance of Adapter that can be used when the callback methods need an empty implementation without incurring in the cost of allocating a new Adapter object.

Method Summary

Modifier and Type	Method and Description
public static Callback	combine(Callback cb1, Callback cb2)
public default void	completeWith(CompletableFuture<?> the CompletableFuture that completes this callback completable) Completes this callback with the given `CompletableFuture`.
public default void	failed(Throwable the reason for the operation failure x) Callback invoked when the operation fails.
public static Callback	Returns: a callback that when completed, completes the given CompletableFuture from(CompletableFuture<?> the CompletableFuture to convert into a callback completable) Creates a non-blocking callback from the given incomplete CompletableFuture.
public static Callback	Returns: a callback that when completed, completes the given CompletableFuture from(CompletableFuture<?> the CompletableFuture to convert into a callback completable, Invocable.InvocationType whether the callback is blocking invocation) Creates a callback from the given incomplete CompletableFuture, with the given `blocking` characteristic.
public static Callback	Returns: a new Callback from(Runnable Called when the callback succeeds success, Consumer<Throwable> Called when the callback fails failure) Creates a callback from the given success and failure lambdas.
public static Callback	Returns: a new Callback from(Invocable.InvocationType the Callback invocation type invocationType, Runnable Called when the callback succeeds success, Consumer<Throwable> Called when the callback fails failure) Creates a callback with the given InvocationType from the given success and failure lambdas.
public static Callback	Returns: a new callback from(Runnable The completion to run on success or failure completed) Creates a callback that runs completed when it succeeds or fails
public static Callback	Returns: a new Callback with the given invocation type from(Invocable.InvocationType the invocation type of the returned Callback invocationType, Runnable the Runnable to run when the callback either succeeds or fails completed) Hides org.eclipse.jetty.util.thread.Invocable.from. Creates a Callback with the given `invocationType`, that runs the given `Runnable` when it succeeds or fails.
public static Callback	Returns: a new callback. from(Callback The nested callback callback, Runnable The completion to run after the nested callback is completed completed) Creates a nested callback that runs completed after completing the nested callback.
public static Callback	Returns: a new callback. from(Callback The nested callback callback, Consumer<Throwable> The completion to run after the nested callback is completed completed) Creates a nested callback that runs completed after completing the nested callback.
public static Callback	Returns: a new callback. from(Runnable The completion to run before the nested callback is completed. Any exceptions thrown from completed will result in a callback failure. completed, Callback The nested callback callback) Creates a nested callback that runs completed before completing the nested callback.
public static Callback	Returns: a new callback. from(Callback The nested callback callback, Throwable The cause to fail the nested callback, if the new callback is failed the reason will be added to this cause as a suppressed exception. cause) Creates a nested callback which always fails the nested callback on completion.
public static Callback	Returns: a new callback. from(Callback The first callback callback1, Callback The second callback callback2) Creates a callback which combines two other callbacks and will succeed or fail them both.
public default void	succeeded() Callback invoked when the operation completes.

Inherited from org.eclipse.jetty.util.thread.Invocable:: combine combine getInvocationType getInvocationType invokeNonBlocking isNonBlockingInvocation

Field Detail

NOOP	back to summary
public static final Callback NOOP Hides org.eclipse.jetty.util.thread.Invocable.NOOP. Instance of Adapter that can be used when the callback methods need an empty implementation without incurring in the cost of allocating a new Adapter object.

NOOP

back to summary

public static final Callback NOOP

Hides org.eclipse.jetty.util.thread.Invocable.NOOP.

Instance of Adapter that can be used when the callback methods need an empty implementation without incurring in the cost of allocating a new Adapter object.

Method Detail

combine	back to summary
public static Callback combine(Callback cb1, Callback cb2)

completeWith back to summary

completeWith	back to summary
public default void completeWith(CompletableFuture<?> completable) Completes this callback with the given `CompletableFuture`. When the CompletableFuture completes normally, this callback is succeeded; when the CompletableFuture completes exceptionally, this callback is failed. Parameters completable:CompletableFuture<?> the CompletableFuture that completes this callback

public default void completeWith(CompletableFuture<?> completable)

Completes this callback with the given CompletableFuture.

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

Parameters

completable:CompletableFuture<?>: the CompletableFuture that completes this callback

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

from	back to summary
public static Callback from(CompletableFuture<?> completable) Creates a non-blocking callback from the given incomplete CompletableFuture. When the callback completes, either succeeding or failing, the CompletableFuture is also completed, respectively via `CompletableFuture#complete(Object)` or `CompletableFuture#completeExceptionally(Throwable)`. Parameters completable:CompletableFuture<?> the CompletableFuture to convert into a callback Returns:Callback a callback that when completed, completes the given CompletableFuture

public static Callback from(CompletableFuture<?> completable)

Creates a non-blocking callback from the given incomplete CompletableFuture.

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

Parameters

completable:CompletableFuture<?>: the CompletableFuture to convert into a callback

Returns:Callback

a callback that when completed, completes the given CompletableFuture

from back to summary

from	back to summary
public static Callback from(CompletableFuture<?> completable, Invocable.InvocationType invocation) Creates a callback from the given incomplete CompletableFuture, with the given `blocking` characteristic. Parameters completable:CompletableFuture<?> the CompletableFuture to convert into a callback invocation:Invocable.InvocationType whether the callback is blocking Returns:Callback a callback that when completed, completes the given CompletableFuture

public static Callback from(CompletableFuture<?> completable, Invocable.InvocationType invocation)

Creates a callback from the given incomplete CompletableFuture, with the given blocking characteristic.

Parameters

completable:CompletableFuture<?>: the CompletableFuture to convert into a callback
invocation:Invocable.InvocationType: whether the callback is blocking

Returns:Callback

a callback that when completed, completes the given CompletableFuture

from	back to summary
public static Callback from(Runnable success, Consumer<Throwable> failure) Creates a callback from the given success and failure lambdas. Parameters success:Runnable Called when the callback succeeds failure:Consumer<Throwable> Called when the callback fails Returns:Callback a new Callback

from

back to summary

public static Callback from(Runnable success, Consumer<Throwable> failure)

Creates a callback from the given success and failure lambdas.

Parameters

success:Runnable: Called when the callback succeeds
failure:Consumer<Throwable>: Called when the callback fails

Returns:Callback

a new Callback

from	back to summary
public static Callback from(Invocable.InvocationType invocationType, Runnable success, Consumer<Throwable> failure) Creates a callback with the given InvocationType from the given success and failure lambdas. Parameters invocationType:Invocable.InvocationType the Callback invocation type success:Runnable Called when the callback succeeds failure:Consumer<Throwable> Called when the callback fails Returns:Callback a new Callback

from

back to summary

public static Callback from(Invocable.InvocationType invocationType, Runnable success, Consumer<Throwable> failure)

Creates a callback with the given InvocationType from the given success and failure lambdas.

Parameters

invocationType:Invocable.InvocationType: the Callback invocation type
success:Runnable: Called when the callback succeeds
failure:Consumer<Throwable>: Called when the callback fails

Returns:Callback

a new Callback

from	back to summary
public static Callback from(Runnable completed) Creates a callback that runs completed when it succeeds or fails Parameters completed:Runnable The completion to run on success or failure Returns:Callback a new callback

from

back to summary

public static Callback from(Runnable completed)

Creates a callback that runs completed when it succeeds or fails

Parameters

completed:Runnable: The completion to run on success or failure

Returns:Callback

a new callback

from back to summary

from	back to summary
public static Callback from(Invocable.InvocationType invocationType, Runnable completed) Hides org.eclipse.jetty.util.thread.Invocable.from. Creates a Callback with the given `invocationType`, that runs the given `Runnable` when it succeeds or fails. Parameters invocationType:Invocable.InvocationType the invocation type of the returned Callback completed:Runnable the Runnable to run when the callback either succeeds or fails Returns:Callback a new Callback with the given invocation type

public static Callback from(Invocable.InvocationType invocationType, Runnable completed)

Hides org.eclipse.jetty.util.thread.Invocable.from.

Creates a Callback with the given invocationType, that runs the given Runnable when it succeeds or fails.

Parameters

invocationType:Invocable.InvocationType: the invocation type of the returned Callback
completed:Runnable: the Runnable to run when the callback either succeeds or fails

Returns:Callback

a new Callback with the given invocation type

from	back to summary
public static Callback from(Callback callback, Runnable completed) Creates a nested callback that runs completed after completing the nested callback. Parameters callback:Callback The nested callback completed:Runnable The completion to run after the nested callback is completed Returns:Callback a new callback.

from

back to summary

public static Callback from(Callback callback, Runnable completed)

Creates a nested callback that runs completed after completing the nested callback.

Parameters

callback:Callback: The nested callback
completed:Runnable: The completion to run after the nested callback is completed

Returns:Callback

a new callback.

from	back to summary
public static Callback from(Callback callback, Consumer<Throwable> completed) Creates a nested callback that runs completed after completing the nested callback. Parameters callback:Callback The nested callback completed:Consumer<Throwable> The completion to run after the nested callback is completed Returns:Callback a new callback.

from

back to summary

public static Callback from(Callback callback, Consumer<Throwable> completed)

Creates a nested callback that runs completed after completing the nested callback.

Parameters

callback:Callback: The nested callback
completed:Consumer<Throwable>: The completion to run after the nested callback is completed

Returns:Callback

a new callback.

from	back to summary
public static Callback from(Runnable completed, Callback callback) Creates a nested callback that runs completed before completing the nested callback. Parameters completed:Runnable The completion to run before the nested callback is completed. Any exceptions thrown from completed will result in a callback failure. callback:Callback The nested callback Returns:Callback a new callback.

from

back to summary

public static Callback from(Runnable completed, Callback callback)

Creates a nested callback that runs completed before completing the nested callback.

Parameters

completed:Runnable: The completion to run before the nested callback is completed. Any exceptions thrown from completed will result in a callback failure.
callback:Callback: The nested callback

Returns:Callback

a new callback.

from	back to summary
public static Callback from(Callback callback, Throwable cause) Creates a nested callback which always fails the nested callback on completion. Parameters callback:Callback The nested callback cause:Throwable The cause to fail the nested callback, if the new callback is failed the reason will be added to this cause as a suppressed exception. Returns:Callback a new callback.

from

back to summary

public static Callback from(Callback callback, Throwable cause)

Creates a nested callback which always fails the nested callback on completion.

Parameters

callback:Callback: The nested callback
cause:Throwable: The cause to fail the nested callback, if the new callback is failed the reason will be added to this cause as a suppressed exception.

Returns:Callback

a new callback.

from	back to summary
public static Callback from(Callback callback1, Callback callback2) Creates a callback which combines two other callbacks and will succeed or fail them both. Parameters callback1:Callback The first callback callback2:Callback The second callback Returns:Callback a new callback.

from

back to summary

public static Callback from(Callback callback1, Callback callback2)

Creates a callback which combines two other callbacks and will succeed or fail them both.

Parameters

callback1:Callback: The first callback
callback2:Callback: The second callback

Returns:Callback

a new callback.

succeeded back to summary

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

public default void succeeded()

Callback invoked when the operation completes.

See Also: failed(Throwable)

org.eclipse.jetty.util back to summary

public Class Callback.Completable

Class Inheritance

extends CompletableFuture<Void>
implements Callback

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

All Implemented Interfaces

org.eclipse.jetty.util.Callback, org.eclipse.jetty.util.thread.Invocable

A CompletableFuture that is also a Callback.

Field Summary

Modifier and Type	Field and Description
private final Invocable.InvocationType	invocation

Constructor Summary

Access	Constructor and Description
public	Completable()
public	Completable(Invocable.InvocationType invocation)

Method Summary

Modifier and Type	Method and Description
public Callback.Completable	Returns: a new `Completable` passed to the consumer compose(Consumer<Callback.Completable> the consumer that receives the `Completable` consumer) Returns a new `Completable` that, when this `Completable` succeeds, is passed to the given consumer and then returned.
public void	failed(Throwable the reason for the operation failure x) Overrides default org.eclipse.jetty.util.Callback.failed. Callback invoked when the operation fails.
public static Callback.Completable	Returns: a new Completable which will succeed this callback when completed. from(Callback The nested callback. callback) Creates a completable future given a callback.
public Invocable.InvocationType	getInvocationType() Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType.
public void	succeeded() Overrides default org.eclipse.jetty.util.Callback.succeeded. Callback invoked when the operation completes.
public static Callback.Completable	Returns: the newly created `Completable` with(Consumer<Callback.Completable> 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

Field Detail

invocation	back to summary
private final Invocable.InvocationType invocation

Constructor Detail

Completable	back to summary
public Completable()

Completable	back to summary
public Completable(Invocable.InvocationType invocation)

Method Detail

compose back to summary

compose	back to summary
public Callback.Completable compose(Consumer<Callback.Completable> consumer) Returns a new `Completable` that, when this `Completable` succeeds, is passed to the given consumer and then returned. If this `Completable` fails, the new `Completable` is also failed, and the consumer is not invoked. Parameters consumer:Consumer<Callback.Completable> the consumer that receives the `Completable` Returns:Callback.Completable a new `Completable` passed to the consumer See Also `with(Consumer)`

public Callback.Completable compose(Consumer<Callback.Completable> consumer)

Returns a new Completable that, when this Completable succeeds, is passed to the given consumer and then returned.

If this Completable fails, the new Completable is also failed, and the consumer is not invoked.

Parameters

consumer:Consumer<Callback.Completable>: the consumer that receives the Completable

Returns:Callback.Completable

a new Completable passed to the consumer

See Also

with(Consumer)

failed	back to summary
public void failed(Throwable x) Overrides default org.eclipse.jetty.util.Callback.failed. Doc from org.eclipse.jetty.util.Callback.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.Callback.failed.

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

Callback invoked when the operation fails.

Parameters

x:Throwable: the reason for the operation failure

Annotations

@Override

from	back to summary
public static Callback.Completable from(Callback callback) Creates a completable future given a callback. Parameters callback:Callback The nested callback. Returns:Callback.Completable a new Completable which will succeed this callback when completed.

from

back to summary

public static Callback.Completable from(Callback callback)

Creates a completable future given a callback.

Parameters

callback:Callback: The nested callback.

Returns:Callback.Completable

a new Completable which will succeed this callback when completed.

getInvocationType	back to summary
public Invocable.InvocationType getInvocationType() Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType. Returns:Invocable.InvocationType Doc from org.eclipse.jetty.util.thread.Invocable.getInvocationType. The InvocationType of this object Annotations @Override

getInvocationType

back to summary

public Invocable.InvocationType getInvocationType()

Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType.

Returns:Invocable.InvocationType

Doc from org.eclipse.jetty.util.thread.Invocable.getInvocationType.

The InvocationType of this object

Annotations

@Override

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

succeeded

back to summary

public void succeeded()

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

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

Callback invoked when the operation completes.

Annotations

@Override

with back to summary

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

public static Callback.Completable with(Consumer<Callback.Completable> consumer)

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

Parameters

consumer:Consumer<Callback.Completable>: the code that consumes the newly created Completable

Returns:Callback.Completable

the newly created Completable

org.eclipse.jetty.util back to summary

public Interface Callback.Completing

Known Direct Implementers: org.eclipse.jetty.util.Callback.Nested

A Callback implementation that calls the completed() method when it either succeeds or fails.

Field Summary

Inherited from org.eclipse.jetty.util.Callback:: NOOP

Method Summary

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

Inherited from org.eclipse.jetty.util.Callback:: combine completeWith from from from from from from from from from from from

Method Detail

completed	back to summary
public void completed()

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

failed

back to summary

public default void failed(Throwable x)

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

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

Callback invoked when the operation fails.

Parameters

x:Throwable: the reason for the operation failure

Annotations

@Override

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

succeeded

back to summary

public default void succeeded()

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

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

Callback invoked when the operation completes.

Annotations

@Override

org.eclipse.jetty.util back to summary

public Class Callback.Nested

Class Inheritance

extends Object
implements Completing

java.lang.Object
org.eclipse.jetty.util.Callback.Nested

All Implemented Interfaces

org.eclipse.jetty.util.Callback.Completing, org.eclipse.jetty.util.Callback, org.eclipse.jetty.util.thread.Invocable

Known Direct Subclasses

org.eclipse.jetty.util.CountingCallback

Nested Completing Callback that completes after completing the nested callback

Field Summary

Modifier and Type	Field and Description
private final Callback	callback

Constructor Summary

Access	Constructor and Description
public	Nested(Callback callback)

Method Summary

Modifier and Type	Method and Description
public void	completed() Implements org.eclipse.jetty.util.Callback.Completing.completed.
public void	failed(Throwable the reason for the operation failure x) Overrides default org.eclipse.jetty.util.Callback.Completing.failed. Callback invoked when the operation fails.
public Callback	getCallback()
public Invocable.InvocationType	getInvocationType() Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType.
public void	succeeded() Overrides default org.eclipse.jetty.util.Callback.Completing.succeeded. Callback invoked when the operation completes.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

callback	back to summary
private final Callback callback

Constructor Detail

Nested	back to summary
public Nested(Callback callback)

Method Detail

completed	back to summary
public void completed() Implements org.eclipse.jetty.util.Callback.Completing.completed. Annotations @Override

completed

back to summary

public void completed()

Implements org.eclipse.jetty.util.Callback.Completing.completed.

Annotations

@Override

failed	back to summary
public void failed(Throwable x) Overrides default org.eclipse.jetty.util.Callback.Completing.failed. Doc from org.eclipse.jetty.util.Callback.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.Callback.Completing.failed.

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

Callback invoked when the operation fails.

Parameters

x:Throwable: the reason for the operation failure

Annotations

@Override

getCallback	back to summary
public Callback getCallback()

getInvocationType	back to summary
public Invocable.InvocationType getInvocationType() Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType. Returns:Invocable.InvocationType Doc from org.eclipse.jetty.util.thread.Invocable.getInvocationType. The InvocationType of this object Annotations @Override

getInvocationType

back to summary

public Invocable.InvocationType getInvocationType()

Overrides default org.eclipse.jetty.util.thread.Invocable.getInvocationType.

Returns:Invocable.InvocationType

Doc from org.eclipse.jetty.util.thread.Invocable.getInvocationType.

The InvocationType of this object

Annotations

@Override

succeeded	back to summary
public void succeeded() Overrides default org.eclipse.jetty.util.Callback.Completing.succeeded. Doc from org.eclipse.jetty.util.Callback.succeeded. Callback invoked when the operation completes. Annotations @Override

succeeded

back to summary

public void succeeded()

Overrides default org.eclipse.jetty.util.Callback.Completing.succeeded.

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

Callback invoked when the operation completes.

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

public Interface Callback

Nested and Inner Type Summary

Field Summary

Method Summary

Field Detail

Method Detail

public Class Callback.Completable

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface Callback.Completing

Field Summary

Method Summary

Method Detail

public Class Callback.Nested

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail