rocks.xmpp.util.concurrent

Class AsyncResult<T>

java.lang.Object

rocks.xmpp.util.concurrent.AsyncResult<T>

All Implemented Interfaces:

java.util.concurrent.CompletionStage<T>, java.util.concurrent.Future<T>

public class AsyncResult<T>
extends java.lang.Object
implements java.util.concurrent.Future<T>, java.util.concurrent.CompletionStage<T>

Represents the result of an asynchronous operation.

It implements both Future and CompletionStage and is therefore similar to CompletableFuture, but read-only, i.e. it cannot be completed.

See Also:

CompletableFuture

Constructor Summary

Constructors

Constructor and Description
AsyncResult(java.util.concurrent.CompletionStage<T> completionStage)

Method Summary

Modifier and Type	Method and Description
AsyncResult<java.lang.Void>	acceptEither(java.util.concurrent.CompletionStage<? extends T> other, java.util.function.Consumer<? super T> action)
AsyncResult<java.lang.Void>	acceptEitherAsync(java.util.concurrent.CompletionStage<? extends T> other, java.util.function.Consumer<? super T> action)
AsyncResult<java.lang.Void>	acceptEitherAsync(java.util.concurrent.CompletionStage<? extends T> other, java.util.function.Consumer<? super T> action, java.util.concurrent.Executor executor)
<U> AsyncResult<U>	applyToEither(java.util.concurrent.CompletionStage<? extends T> other, java.util.function.Function<? super T,U> fn)
<U> AsyncResult<U>	applyToEitherAsync(java.util.concurrent.CompletionStage<? extends T> other, java.util.function.Function<? super T,U> fn)
<U> AsyncResult<U>	applyToEitherAsync(java.util.concurrent.CompletionStage<? extends T> other, java.util.function.Function<? super T,U> fn, java.util.concurrent.Executor executor)
boolean	cancel() Cancels the processing of this Future, i.e. completes it with a CancellationException.
boolean	cancel(boolean mayInterruptIfRunning) Cancels the processing of this Future, i.e. completes it with a CancellationException.
AsyncResult<T>	exceptionally(java.util.function.Function<java.lang.Throwable,? extends T> fn)
T	get()
T	get(long timeout, java.util.concurrent.TimeUnit unit)
T	getResult() Waits uninterruptibly on the result of the query and returns it.
T	getResult(long timeout, java.util.concurrent.TimeUnit unit) Waits uninterruptibly on the result of the query (with a timeout) and returns it.
<U> AsyncResult<U>	handle(java.util.function.BiFunction<? super T,java.lang.Throwable,? extends U> fn)
<U> AsyncResult<U>	handleAsync(java.util.function.BiFunction<? super T,java.lang.Throwable,? extends U> fn)
<U> AsyncResult<U>	handleAsync(java.util.function.BiFunction<? super T,java.lang.Throwable,? extends U> fn, java.util.concurrent.Executor executor)
boolean	isCancelled()
boolean	isDone()
AsyncResult<java.lang.Void>	runAfterBoth(java.util.concurrent.CompletionStage<?> other, java.lang.Runnable action)
AsyncResult<java.lang.Void>	runAfterBothAsync(java.util.concurrent.CompletionStage<?> other, java.lang.Runnable action)
AsyncResult<java.lang.Void>	runAfterBothAsync(java.util.concurrent.CompletionStage<?> other, java.lang.Runnable action, java.util.concurrent.Executor executor)
AsyncResult<java.lang.Void>	runAfterEither(java.util.concurrent.CompletionStage<?> other, java.lang.Runnable action)
AsyncResult<java.lang.Void>	runAfterEitherAsync(java.util.concurrent.CompletionStage<?> other, java.lang.Runnable action)
AsyncResult<java.lang.Void>	runAfterEitherAsync(java.util.concurrent.CompletionStage<?> other, java.lang.Runnable action, java.util.concurrent.Executor executor)
AsyncResult<java.lang.Void>	thenAccept(java.util.function.Consumer<? super T> action)
AsyncResult<java.lang.Void>	thenAcceptAsync(java.util.function.Consumer<? super T> action)
AsyncResult<java.lang.Void>	thenAcceptAsync(java.util.function.Consumer<? super T> action, java.util.concurrent.Executor executor)
<U> AsyncResult<java.lang.Void>	thenAcceptBoth(java.util.concurrent.CompletionStage<? extends U> other, java.util.function.BiConsumer<? super T,? super U> action)
<U> AsyncResult<java.lang.Void>	thenAcceptBothAsync(java.util.concurrent.CompletionStage<? extends U> other, java.util.function.BiConsumer<? super T,? super U> action)
<U> AsyncResult<java.lang.Void>	thenAcceptBothAsync(java.util.concurrent.CompletionStage<? extends U> other, java.util.function.BiConsumer<? super T,? super U> action, java.util.concurrent.Executor executor)
<U> AsyncResult<U>	thenApply(java.util.function.Function<? super T,? extends U> fn)
<U> AsyncResult<U>	thenApplyAsync(java.util.function.Function<? super T,? extends U> fn)
<U> AsyncResult<U>	thenApplyAsync(java.util.function.Function<? super T,? extends U> fn, java.util.concurrent.Executor executor)
<U,V> AsyncResult<V>	thenCombine(java.util.concurrent.CompletionStage<? extends U> other, java.util.function.BiFunction<? super T,? super U,? extends V> fn)
<U,V> AsyncResult<V>	thenCombineAsync(java.util.concurrent.CompletionStage<? extends U> other, java.util.function.BiFunction<? super T,? super U,? extends V> fn)
<U,V> AsyncResult<V>	thenCombineAsync(java.util.concurrent.CompletionStage<? extends U> other, java.util.function.BiFunction<? super T,? super U,? extends V> fn, java.util.concurrent.Executor executor)
<U> AsyncResult<U>	thenCompose(java.util.function.Function<? super T,? extends java.util.concurrent.CompletionStage<U>> fn)
<U> AsyncResult<U>	thenComposeAsync(java.util.function.Function<? super T,? extends java.util.concurrent.CompletionStage<U>> fn)
<U> AsyncResult<U>	thenComposeAsync(java.util.function.Function<? super T,? extends java.util.concurrent.CompletionStage<U>> fn, java.util.concurrent.Executor executor)
AsyncResult<java.lang.Void>	thenRun(java.lang.Runnable action)
AsyncResult<java.lang.Void>	thenRunAsync(java.lang.Runnable action)
AsyncResult<java.lang.Void>	thenRunAsync(java.lang.Runnable action, java.util.concurrent.Executor executor)
java.util.concurrent.CompletableFuture<T>	toCompletableFuture()
AsyncResult<T>	whenComplete(java.util.function.BiConsumer<? super T,? super java.lang.Throwable> action)
AsyncResult<T>	whenCompleteAsync(java.util.function.BiConsumer<? super T,? super java.lang.Throwable> action)
AsyncResult<T>	whenCompleteAsync(java.util.function.BiConsumer<? super T,? super java.lang.Throwable> action, java.util.concurrent.Executor executor)

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncResult

public AsyncResult(java.util.concurrent.CompletionStage<T> completionStage)

Method Detail

thenApply

public <U> AsyncResult<U> thenApply(java.util.function.Function<? super T,? extends U> fn)

Specified by:

thenApply in interface java.util.concurrent.CompletionStage<T>

thenApplyAsync

public <U> AsyncResult<U> thenApplyAsync(java.util.function.Function<? super T,? extends U> fn)

Specified by:

thenApplyAsync in interface java.util.concurrent.CompletionStage<T>

thenApplyAsync

public <U> AsyncResult<U> thenApplyAsync(java.util.function.Function<? super T,? extends U> fn,
                                         java.util.concurrent.Executor executor)

Specified by:

thenApplyAsync in interface java.util.concurrent.CompletionStage<T>

thenAccept

public AsyncResult<java.lang.Void> thenAccept(java.util.function.Consumer<? super T> action)

Specified by:

thenAccept in interface java.util.concurrent.CompletionStage<T>

thenAcceptAsync

public AsyncResult<java.lang.Void> thenAcceptAsync(java.util.function.Consumer<? super T> action)

Specified by:

thenAcceptAsync in interface java.util.concurrent.CompletionStage<T>

thenAcceptAsync

public AsyncResult<java.lang.Void> thenAcceptAsync(java.util.function.Consumer<? super T> action,
                                                   java.util.concurrent.Executor executor)

Specified by:

thenAcceptAsync in interface java.util.concurrent.CompletionStage<T>

thenRun

public AsyncResult<java.lang.Void> thenRun(java.lang.Runnable action)

Specified by:

thenRun in interface java.util.concurrent.CompletionStage<T>

thenRunAsync

public AsyncResult<java.lang.Void> thenRunAsync(java.lang.Runnable action)

Specified by:

thenRunAsync in interface java.util.concurrent.CompletionStage<T>

thenRunAsync

public AsyncResult<java.lang.Void> thenRunAsync(java.lang.Runnable action,
                                                java.util.concurrent.Executor executor)

Specified by:

thenRunAsync in interface java.util.concurrent.CompletionStage<T>

thenCombine

public <U,V> AsyncResult<V> thenCombine(java.util.concurrent.CompletionStage<? extends U> other,
                                        java.util.function.BiFunction<? super T,? super U,? extends V> fn)

Specified by:

thenCombine in interface java.util.concurrent.CompletionStage<T>

thenCombineAsync

public <U,V> AsyncResult<V> thenCombineAsync(java.util.concurrent.CompletionStage<? extends U> other,
                                             java.util.function.BiFunction<? super T,? super U,? extends V> fn)

Specified by:

thenCombineAsync in interface java.util.concurrent.CompletionStage<T>

thenCombineAsync

public <U,V> AsyncResult<V> thenCombineAsync(java.util.concurrent.CompletionStage<? extends U> other,
                                             java.util.function.BiFunction<? super T,? super U,? extends V> fn,
                                             java.util.concurrent.Executor executor)

Specified by:

thenCombineAsync in interface java.util.concurrent.CompletionStage<T>

thenAcceptBoth

public <U> AsyncResult<java.lang.Void> thenAcceptBoth(java.util.concurrent.CompletionStage<? extends U> other,
                                                      java.util.function.BiConsumer<? super T,? super U> action)

Specified by:

thenAcceptBoth in interface java.util.concurrent.CompletionStage<T>

thenAcceptBothAsync

public <U> AsyncResult<java.lang.Void> thenAcceptBothAsync(java.util.concurrent.CompletionStage<? extends U> other,
                                                           java.util.function.BiConsumer<? super T,? super U> action)

Specified by:

thenAcceptBothAsync in interface java.util.concurrent.CompletionStage<T>

thenAcceptBothAsync

public <U> AsyncResult<java.lang.Void> thenAcceptBothAsync(java.util.concurrent.CompletionStage<? extends U> other,
                                                           java.util.function.BiConsumer<? super T,? super U> action,
                                                           java.util.concurrent.Executor executor)

Specified by:

thenAcceptBothAsync in interface java.util.concurrent.CompletionStage<T>

runAfterBoth

public AsyncResult<java.lang.Void> runAfterBoth(java.util.concurrent.CompletionStage<?> other,
                                                java.lang.Runnable action)

Specified by:

runAfterBoth in interface java.util.concurrent.CompletionStage<T>

runAfterBothAsync

public AsyncResult<java.lang.Void> runAfterBothAsync(java.util.concurrent.CompletionStage<?> other,
                                                     java.lang.Runnable action)

Specified by:

runAfterBothAsync in interface java.util.concurrent.CompletionStage<T>

runAfterBothAsync

public AsyncResult<java.lang.Void> runAfterBothAsync(java.util.concurrent.CompletionStage<?> other,
                                                     java.lang.Runnable action,
                                                     java.util.concurrent.Executor executor)

Specified by:

runAfterBothAsync in interface java.util.concurrent.CompletionStage<T>

applyToEither

public <U> AsyncResult<U> applyToEither(java.util.concurrent.CompletionStage<? extends T> other,
                                        java.util.function.Function<? super T,U> fn)

Specified by:

applyToEither in interface java.util.concurrent.CompletionStage<T>

applyToEitherAsync

public <U> AsyncResult<U> applyToEitherAsync(java.util.concurrent.CompletionStage<? extends T> other,
                                             java.util.function.Function<? super T,U> fn)

Specified by:

applyToEitherAsync in interface java.util.concurrent.CompletionStage<T>

applyToEitherAsync

public <U> AsyncResult<U> applyToEitherAsync(java.util.concurrent.CompletionStage<? extends T> other,
                                             java.util.function.Function<? super T,U> fn,
                                             java.util.concurrent.Executor executor)

Specified by:

applyToEitherAsync in interface java.util.concurrent.CompletionStage<T>

acceptEither

public AsyncResult<java.lang.Void> acceptEither(java.util.concurrent.CompletionStage<? extends T> other,
                                                java.util.function.Consumer<? super T> action)

Specified by:

acceptEither in interface java.util.concurrent.CompletionStage<T>

acceptEitherAsync

public AsyncResult<java.lang.Void> acceptEitherAsync(java.util.concurrent.CompletionStage<? extends T> other,
                                                     java.util.function.Consumer<? super T> action)

Specified by:

acceptEitherAsync in interface java.util.concurrent.CompletionStage<T>

acceptEitherAsync

public AsyncResult<java.lang.Void> acceptEitherAsync(java.util.concurrent.CompletionStage<? extends T> other,
                                                     java.util.function.Consumer<? super T> action,
                                                     java.util.concurrent.Executor executor)

Specified by:

acceptEitherAsync in interface java.util.concurrent.CompletionStage<T>

runAfterEither

public AsyncResult<java.lang.Void> runAfterEither(java.util.concurrent.CompletionStage<?> other,
                                                  java.lang.Runnable action)

Specified by:

runAfterEither in interface java.util.concurrent.CompletionStage<T>

runAfterEitherAsync

public AsyncResult<java.lang.Void> runAfterEitherAsync(java.util.concurrent.CompletionStage<?> other,
                                                       java.lang.Runnable action)

Specified by:

runAfterEitherAsync in interface java.util.concurrent.CompletionStage<T>

runAfterEitherAsync

public AsyncResult<java.lang.Void> runAfterEitherAsync(java.util.concurrent.CompletionStage<?> other,
                                                       java.lang.Runnable action,
                                                       java.util.concurrent.Executor executor)

Specified by:

runAfterEitherAsync in interface java.util.concurrent.CompletionStage<T>

thenCompose

public <U> AsyncResult<U> thenCompose(java.util.function.Function<? super T,? extends java.util.concurrent.CompletionStage<U>> fn)

Specified by:

thenCompose in interface java.util.concurrent.CompletionStage<T>

thenComposeAsync

public <U> AsyncResult<U> thenComposeAsync(java.util.function.Function<? super T,? extends java.util.concurrent.CompletionStage<U>> fn)

Specified by:

thenComposeAsync in interface java.util.concurrent.CompletionStage<T>

thenComposeAsync

public <U> AsyncResult<U> thenComposeAsync(java.util.function.Function<? super T,? extends java.util.concurrent.CompletionStage<U>> fn,
                                           java.util.concurrent.Executor executor)

Specified by:

thenComposeAsync in interface java.util.concurrent.CompletionStage<T>

exceptionally

public AsyncResult<T> exceptionally(java.util.function.Function<java.lang.Throwable,? extends T> fn)

Specified by:

exceptionally in interface java.util.concurrent.CompletionStage<T>

whenComplete

public AsyncResult<T> whenComplete(java.util.function.BiConsumer<? super T,? super java.lang.Throwable> action)

Specified by:

whenComplete in interface java.util.concurrent.CompletionStage<T>

whenCompleteAsync

public AsyncResult<T> whenCompleteAsync(java.util.function.BiConsumer<? super T,? super java.lang.Throwable> action)

Specified by:

whenCompleteAsync in interface java.util.concurrent.CompletionStage<T>

whenCompleteAsync

public AsyncResult<T> whenCompleteAsync(java.util.function.BiConsumer<? super T,? super java.lang.Throwable> action,
                                        java.util.concurrent.Executor executor)

Specified by:

whenCompleteAsync in interface java.util.concurrent.CompletionStage<T>

handle

public <U> AsyncResult<U> handle(java.util.function.BiFunction<? super T,java.lang.Throwable,? extends U> fn)

Specified by:

handle in interface java.util.concurrent.CompletionStage<T>

handleAsync

public <U> AsyncResult<U> handleAsync(java.util.function.BiFunction<? super T,java.lang.Throwable,? extends U> fn)

Specified by:

handleAsync in interface java.util.concurrent.CompletionStage<T>

handleAsync

public <U> AsyncResult<U> handleAsync(java.util.function.BiFunction<? super T,java.lang.Throwable,? extends U> fn,
                                      java.util.concurrent.Executor executor)

Specified by:

handleAsync in interface java.util.concurrent.CompletionStage<T>

toCompletableFuture

public final java.util.concurrent.CompletableFuture<T> toCompletableFuture()

Specified by:

toCompletableFuture in interface java.util.concurrent.CompletionStage<T>

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Cancels the processing of this Future, i.e. completes it with a CancellationException.

Specified by:

cancel in interface java.util.concurrent.Future<T>

Parameters:

mayInterruptIfRunning - this value has no effect in this implementation because interrupts are not used to control processing.

Returns:

If this Future is now cancelled.

See Also:

cancel()

cancel

public boolean cancel()

Cancels the processing of this Future, i.e. completes it with a CancellationException.

This method is a shortcut to cancel(boolean), because the boolean parameter has no effect in this implementation.

Returns:

If this Future is now cancelled.

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface java.util.concurrent.Future<T>

isDone

public boolean isDone()

Specified by:

isDone in interface java.util.concurrent.Future<T>

get

public T get()
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException

Specified by:

get in interface java.util.concurrent.Future<T>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

get

public T get(long timeout,
             java.util.concurrent.TimeUnit unit)
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException,
             java.util.concurrent.TimeoutException

Specified by:

get in interface java.util.concurrent.Future<T>

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

getResult

public final T getResult()
                  throws XmppException

Waits uninterruptibly on the result of the query and returns it.

If the thread, waiting on the result is interrupted, this method continues to block until the result is available.

Returns:

The result.

Throws:

XmppException - If the response threw an exception.

getResult

public final T getResult(long timeout,
                         java.util.concurrent.TimeUnit unit)
                  throws XmppException,
                         java.util.concurrent.TimeoutException

Waits uninterruptibly on the result of the query (with a timeout) and returns it.

If the thread, waiting on the result is interrupted, this method continues to block until the result is available or the timeout elapses.

Parameters:

timeout - The timeout

unit - The time unit.

Returns:

The result.

Throws:

XmppException - If the response threw an exception.

java.util.concurrent.TimeoutException - If the result didn’t receive in time.