Package rocks.xmpp.util.concurrent

Class AsyncResult<T>

java.lang.Object

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

All Implemented Interfaces:

CompletionStage<T>, Future<T>

public class AsyncResult<T>
extends Object
implements Future<T>, 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	Description
AsyncResult(CompletionStage<T> completionStage)

Method Summary

Modifier and Type	Method	Description
AsyncResult<Void>	acceptEither(CompletionStage<? extends T> other, Consumer<? super T> action)
AsyncResult<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action)
AsyncResult<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)
<U> AsyncResult<U>	applyToEither(CompletionStage<? extends T> other, Function<? super T,U> fn)
<U> AsyncResult<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn)
<U> AsyncResult<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn, 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(Function<Throwable,? extends T> fn)
T	get()
T	get(long timeout, TimeUnit unit)
T	getResult()	Waits uninterruptibly on the result of the query and returns it.
T	getResult(long timeout, TimeUnit unit)	Waits uninterruptibly on the result of the query (with a timeout) and returns it.
<U> AsyncResult<U>	handle(BiFunction<? super T,Throwable,? extends U> fn)
<U> AsyncResult<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> fn)
<U> AsyncResult<U>	handleAsync(BiFunction<? super T,Throwable,? extends U> fn, Executor executor)
boolean	isCancelled()
boolean	isDone()
AsyncResult<Void>	runAfterBoth(CompletionStage<?> other, Runnable action)
AsyncResult<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action)
AsyncResult<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action, Executor executor)
AsyncResult<Void>	runAfterEither(CompletionStage<?> other, Runnable action)
AsyncResult<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action)
AsyncResult<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action, Executor executor)
AsyncResult<Void>	thenAccept(Consumer<? super T> action)
AsyncResult<Void>	thenAcceptAsync(Consumer<? super T> action)
AsyncResult<Void>	thenAcceptAsync(Consumer<? super T> action, Executor executor)
<U> AsyncResult<Void>	thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
<U> AsyncResult<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
<U> AsyncResult<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action, Executor executor)
<U> AsyncResult<U>	thenApply(Function<? super T,? extends U> fn)
<U> AsyncResult<U>	thenApplyAsync(Function<? super T,? extends U> fn)
<U> AsyncResult<U>	thenApplyAsync(Function<? super T,? extends U> fn, Executor executor)
<U,V> AsyncResult<V>	thenCombine(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
<U,V> AsyncResult<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
<U,V> AsyncResult<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn, Executor executor)
<U> AsyncResult<U>	thenCompose(Function<? super T,? extends CompletionStage<U>> fn)
<U> AsyncResult<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn)
<U> AsyncResult<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn, Executor executor)
AsyncResult<Void>	thenRun(Runnable action)
AsyncResult<Void>	thenRunAsync(Runnable action)
AsyncResult<Void>	thenRunAsync(Runnable action, Executor executor)
CompletableFuture<T>	toCompletableFuture()
AsyncResult<T>	whenComplete(BiConsumer<? super T,? super Throwable> action)
AsyncResult<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> action)
AsyncResult<T>	whenCompleteAsync(BiConsumer<? super T,? super Throwable> action, Executor executor)

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncResult

public AsyncResult(CompletionStage<T> completionStage)

Method Detail

thenApply

public <U> AsyncResult<U> thenApply(Function<? super T,? extends U> fn)

Specified by:

thenApply in interface CompletionStage<T>

thenApplyAsync

public <U> AsyncResult<U> thenApplyAsync(Function<? super T,? extends U> fn)

Specified by:

thenApplyAsync in interface CompletionStage<T>

thenApplyAsync

public <U> AsyncResult<U> thenApplyAsync(Function<? super T,? extends U> fn,
                                         Executor executor)

Specified by:

thenApplyAsync in interface CompletionStage<T>

thenAccept

public AsyncResult<Void> thenAccept(Consumer<? super T> action)

Specified by:

thenAccept in interface CompletionStage<T>

thenAcceptAsync

public AsyncResult<Void> thenAcceptAsync(Consumer<? super T> action)

Specified by:

thenAcceptAsync in interface CompletionStage<T>

thenAcceptAsync

public AsyncResult<Void> thenAcceptAsync(Consumer<? super T> action,
                                         Executor executor)

Specified by:

thenAcceptAsync in interface CompletionStage<T>

thenRun

public AsyncResult<Void> thenRun(Runnable action)

Specified by:

thenRun in interface CompletionStage<T>

thenRunAsync

public AsyncResult<Void> thenRunAsync(Runnable action)

Specified by:

thenRunAsync in interface CompletionStage<T>

thenRunAsync

public AsyncResult<Void> thenRunAsync(Runnable action,
                                      Executor executor)

Specified by:

thenRunAsync in interface CompletionStage<T>

thenCombine

public <U,V> AsyncResult<V> thenCombine(CompletionStage<? extends U> other,
                                              BiFunction<? super T,? super U,? extends V> fn)

Specified by:

thenCombine in interface CompletionStage<T>

thenCombineAsync

public <U,V> AsyncResult<V> thenCombineAsync(CompletionStage<? extends U> other,
                                                   BiFunction<? super T,? super U,? extends V> fn)

Specified by:

thenCombineAsync in interface CompletionStage<T>

thenCombineAsync

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

Specified by:

thenCombineAsync in interface CompletionStage<T>

thenAcceptBoth

public <U> AsyncResult<Void> thenAcceptBoth(CompletionStage<? extends U> other,
                                            BiConsumer<? super T,? super U> action)

Specified by:

thenAcceptBoth in interface CompletionStage<T>

thenAcceptBothAsync

public <U> AsyncResult<Void> thenAcceptBothAsync(CompletionStage<? extends U> other,
                                                 BiConsumer<? super T,? super U> action)

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

thenAcceptBothAsync

public <U> AsyncResult<Void> thenAcceptBothAsync(CompletionStage<? extends U> other,
                                                 BiConsumer<? super T,? super U> action,
                                                 Executor executor)

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

runAfterBoth

public AsyncResult<Void> runAfterBoth(CompletionStage<?> other,
                                      Runnable action)

Specified by:

runAfterBoth in interface CompletionStage<T>

runAfterBothAsync

public AsyncResult<Void> runAfterBothAsync(CompletionStage<?> other,
                                           Runnable action)

Specified by:

runAfterBothAsync in interface CompletionStage<T>

runAfterBothAsync

public AsyncResult<Void> runAfterBothAsync(CompletionStage<?> other,
                                           Runnable action,
                                           Executor executor)

Specified by:

runAfterBothAsync in interface CompletionStage<T>

applyToEither

public <U> AsyncResult<U> applyToEither(CompletionStage<? extends T> other,
                                        Function<? super T,U> fn)

Specified by:

applyToEither in interface CompletionStage<T>

applyToEitherAsync

public <U> AsyncResult<U> applyToEitherAsync(CompletionStage<? extends T> other,
                                             Function<? super T,U> fn)

Specified by:

applyToEitherAsync in interface CompletionStage<T>

applyToEitherAsync

public <U> AsyncResult<U> applyToEitherAsync(CompletionStage<? extends T> other,
                                             Function<? super T,U> fn,
                                             Executor executor)

Specified by:

applyToEitherAsync in interface CompletionStage<T>

acceptEither

public AsyncResult<Void> acceptEither(CompletionStage<? extends T> other,
                                      Consumer<? super T> action)

Specified by:

acceptEither in interface CompletionStage<T>

acceptEitherAsync

public AsyncResult<Void> acceptEitherAsync(CompletionStage<? extends T> other,
                                           Consumer<? super T> action)

Specified by:

acceptEitherAsync in interface CompletionStage<T>

acceptEitherAsync

public AsyncResult<Void> acceptEitherAsync(CompletionStage<? extends T> other,
                                           Consumer<? super T> action,
                                           Executor executor)

Specified by:

acceptEitherAsync in interface CompletionStage<T>

runAfterEither

public AsyncResult<Void> runAfterEither(CompletionStage<?> other,
                                        Runnable action)

Specified by:

runAfterEither in interface CompletionStage<T>

runAfterEitherAsync

public AsyncResult<Void> runAfterEitherAsync(CompletionStage<?> other,
                                             Runnable action)

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

runAfterEitherAsync

public AsyncResult<Void> runAfterEitherAsync(CompletionStage<?> other,
                                             Runnable action,
                                             Executor executor)

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

thenCompose

public <U> AsyncResult<U> thenCompose(Function<? super T,? extends CompletionStage<U>> fn)

Specified by:

thenCompose in interface CompletionStage<T>

thenComposeAsync

public <U> AsyncResult<U> thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn)

Specified by:

thenComposeAsync in interface CompletionStage<T>

thenComposeAsync

public <U> AsyncResult<U> thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn,
                                           Executor executor)

Specified by:

thenComposeAsync in interface CompletionStage<T>

exceptionally

public AsyncResult<T> exceptionally(Function<Throwable,? extends T> fn)

Specified by:

exceptionally in interface CompletionStage<T>

whenComplete

public AsyncResult<T> whenComplete(BiConsumer<? super T,? super Throwable> action)

Specified by:

whenComplete in interface CompletionStage<T>

whenCompleteAsync

public AsyncResult<T> whenCompleteAsync(BiConsumer<? super T,? super Throwable> action)

Specified by:

whenCompleteAsync in interface CompletionStage<T>

whenCompleteAsync

public AsyncResult<T> whenCompleteAsync(BiConsumer<? super T,? super Throwable> action,
                                        Executor executor)

Specified by:

whenCompleteAsync in interface CompletionStage<T>

handle

public <U> AsyncResult<U> handle(BiFunction<? super T,Throwable,? extends U> fn)

Specified by:

handle in interface CompletionStage<T>

handleAsync

public <U> AsyncResult<U> handleAsync(BiFunction<? super T,Throwable,? extends U> fn)

Specified by:

handleAsync in interface CompletionStage<T>

handleAsync

public <U> AsyncResult<U> handleAsync(BiFunction<? super T,Throwable,? extends U> fn,
                                      Executor executor)

Specified by:

handleAsync in interface CompletionStage<T>

toCompletableFuture

public final CompletableFuture<T> toCompletableFuture()

Specified by:

toCompletableFuture in interface 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 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 Future<T>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<T>

get

public T get()
      throws InterruptedException,
             ExecutionException

Specified by:

get in interface Future<T>

Throws:

InterruptedException

ExecutionException

get

public T get(long timeout,
             TimeUnit unit)
      throws InterruptedException,
             ExecutionException,
             TimeoutException

Specified by:

get in interface Future<T>

Throws:

InterruptedException

ExecutionException

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,
                         TimeUnit unit)
                  throws XmppException,
                         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.

TimeoutException - If the result didn't receive in time.