Package com.linkedin.alpini.base.concurrency.impl

Class FailedAsyncFuture<T>

java.lang.Object

com.linkedin.alpini.base.concurrency.impl.AbstractAsyncFuture<T>

com.linkedin.alpini.base.concurrency.impl.FailedAsyncFuture<T>

All Implemented Interfaces:

AsyncFuture<T>, AsyncPromise<T>, CompletionStage<T>, Future<T>

Direct Known Subclasses:

CancelledAsyncFuture

public class FailedAsyncFuture<T>
extends AbstractAsyncFuture<T>
implements AsyncPromise<T>

Nested Class Summary

Nested classes/interfaces inherited from interface com.linkedin.alpini.base.concurrency.AsyncFuture

AsyncFuture.Status

Field Summary

Fields inherited from interface com.linkedin.alpini.base.concurrency.AsyncFuture

NULL_SUCCESS

Constructor Summary

Constructors

Constructor	Description
FailedAsyncFuture(Throwable throwable)

Method Summary

Modifier and Type	Method	Description
CompletionStage<Void>	acceptEither(CompletionStage<? extends T> other, Consumer<? super T> action)
CompletionStage<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action)
CompletionStage<Void>	acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)
final AsyncPromise<T>	addListener(AsyncFutureListener<T> listener)	Adds the specified listener to this future.
final AsyncPromise<T>	addListener(AsyncPromise<T> listener)	Adds the specified future as a listener to this future.
<U> CompletionStage<U>	applyToEither(CompletionStage<? extends T> other, Function<? super T,U> fn)
<U> CompletionStage<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn)
<U> CompletionStage<U>	applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T,U> fn, Executor executor)
final AsyncFuture<T>	await()	Waits for this future to be completed.
final boolean	await(long timeout, TimeUnit unit)	Waits for this future to be completed within the specified time limit.
final AsyncFuture<T>	awaitUninterruptibly()	Waits for this future to be completed without interruption.
final boolean	awaitUninterruptibly(long timeout, TimeUnit unit)	Waits for this future to be completed within the specified time limit without interruption.
final boolean	cancel(boolean mayInterruptIfRunning)	Attempts to cancel execution of this task.
final T	get()	Waits if necessary for the computation to complete, and then retrieves its result.
final T	get(long timeout, TimeUnit unit)	Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
final Throwable	getCause()	Returns the cause of the failed I/O operation if the I/O operation has failed.
final T	getNow()	Non-blocking variant of Future.get()
boolean	isCancelled()	Returns true if this task was cancelled before it completed normally.
final boolean	isDone()	Returns true if this task completed.
final boolean	isSuccess()	Returns true if and only if the I/O operation was completed successfully.
CompletionStage<Void>	runAfterBoth(CompletionStage<?> other, Runnable action)
CompletionStage<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action)
CompletionStage<Void>	runAfterBothAsync(CompletionStage<?> other, Runnable action, Executor executor)
CompletionStage<Void>	runAfterEither(CompletionStage<?> other, Runnable action)
CompletionStage<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action)
CompletionStage<Void>	runAfterEitherAsync(CompletionStage<?> other, Runnable action, Executor executor)
final boolean	setFailure(Throwable cause)	Marks this future as a failure and notifies all listeners.
final boolean	setSuccess(T result)	Marks this future as a success and notifies all listeners.
CompletionStage<Void>	thenAccept(Consumer<? super T> action)
CompletionStage<Void>	thenAcceptAsync(Consumer<? super T> action)
CompletionStage<Void>	thenAcceptAsync(Consumer<? super T> action, Executor executor)
<U> CompletionStage<Void>	thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
<U> CompletionStage<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action)
<U> CompletionStage<Void>	thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T,? super U> action, Executor executor)
<U> CompletionStage<U>	thenApply(Function<? super T,? extends U> fn)
<U> CompletionStage<U>	thenApplyAsync(Function<? super T,? extends U> fn)
<U> CompletionStage<U>	thenApplyAsync(Function<? super T,? extends U> fn, Executor executor)
<U, V> CompletionStage<V>	thenCombine(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
<U, V> CompletionStage<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
<U, V> CompletionStage<V>	thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn, Executor executor)
<U> CompletionStage<U>	thenCompose(Function<? super T,? extends CompletionStage<U>> fn)
<U> CompletionStage<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn)
<U> CompletionStage<U>	thenComposeAsync(Function<? super T,? extends CompletionStage<U>> fn, Executor executor)
CompletionStage<Void>	thenRun(Runnable action)
CompletionStage<Void>	thenRunAsync(Runnable action)
CompletionStage<Void>	thenRunAsync(Runnable action, Executor executor)
CompletableFuture<T>	toCompletableFuture()

Methods inherited from class com.linkedin.alpini.base.concurrency.impl.AbstractAsyncFuture

exceptionally, handle, handleAsync, handleAsync, whenComplete, whenCompleteAsync, whenCompleteAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linkedin.alpini.base.concurrency.AsyncPromise

setComplete

Methods inherited from interface java.util.concurrent.CompletionStage

exceptionally, exceptionallyAsync, exceptionallyAsync, exceptionallyCompose, exceptionallyComposeAsync, exceptionallyComposeAsync, handle, handleAsync, handleAsync, whenComplete, whenCompleteAsync, whenCompleteAsync

Constructor Details

FailedAsyncFuture

public FailedAsyncFuture(@Nonnull
 Throwable throwable)

Method Details

isSuccess

public final boolean isSuccess()

Returns true if and only if the I/O operation was completed successfully.

Specified by:

isSuccess in interface AsyncFuture<T>

getCause

public final Throwable getCause()

Returns the cause of the failed I/O operation if the I/O operation has failed.

Specified by:

getCause in interface AsyncFuture<T>

Returns:

the cause of the failure. null if succeeded or this future is not completed yet.

setSuccess

public final boolean setSuccess(T result)

Marks this future as a success and notifies all listeners.

Specified by:

setSuccess in interface AsyncPromise<T>

Parameters:

result -

Returns:

true if and only if successfully marked this future as a success. Otherwise false because this future is already marked as either a success or a failure.

setFailure

public final boolean setFailure(@Nonnull
 Throwable cause)

Marks this future as a failure and notifies all listeners.

Specified by:

setFailure in interface AsyncPromise<T>

Parameters:

cause -

Returns:

true if and only if successfully marked this future as a failure. Otherwise false because this future is already marked as either a success or a failure.

addListener

@Nonnull
public final AsyncPromise<T> addListener(@Nonnull
 AsyncFutureListener<T> listener)

Adds the specified listener to this future. The specified listener is notified when this future is done. If this future is already completed, the specified listener is notified immediately.

Specified by:

addListener in interface AsyncFuture<T>

Specified by:

addListener in interface AsyncPromise<T>

Parameters:

listener -

Returns:

this to permit chaining of operations.

addListener

@Nonnull
public final AsyncPromise<T> addListener(@Nonnull
 AsyncPromise<T> listener)

Adds the specified future as a listener to this future. The specified future is notified when this future is done. If this future is already completed, the specified future is notified immediately.

Specified by:

addListener in interface AsyncFuture<T>

Specified by:

addListener in interface AsyncPromise<T>

Parameters:

listener -

Returns:

this to permit chaining of operations.

await

@Nonnull
public final AsyncFuture<T> await()
                           throws InterruptedException

Waits for this future to be completed.

Specified by:

await in interface AsyncFuture<T>

Throws:

InterruptedException - if the current thread was interrupted

awaitUninterruptibly

@Nonnull
public final AsyncFuture<T> awaitUninterruptibly()

Waits for this future to be completed without interruption. This method catches an InterruptedException and discards it silently.

Specified by:

awaitUninterruptibly in interface AsyncFuture<T>

await

public final boolean await(long timeout,
 @Nonnull
 TimeUnit unit)
                    throws InterruptedException

Waits for this future to be completed within the specified time limit.

Specified by:

await in interface AsyncFuture<T>

Parameters:

timeout -

unit -

Returns:

true if and only if the future was completed within the specified time limit

Throws:

InterruptedException - if the current thread was interrupted

awaitUninterruptibly

public final boolean awaitUninterruptibly(long timeout,
 @Nonnull
 TimeUnit unit)

Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.

Specified by:

awaitUninterruptibly in interface AsyncFuture<T>

Parameters:

timeout -

unit -

Returns:

true if and only if the future was completed within the specified time limit

cancel

public final boolean cancel(boolean mayInterruptIfRunning)

Attempts to cancel execution of this task. This attempt will fail if the task has already completed, has already been cancelled, or could not be cancelled for some other reason. If successful, and this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task should be interrupted in an attempt to stop the task.

After this method returns, subsequent calls to isDone() will always return true. Subsequent calls to isCancelled() will always return true if this method returned true.

Specified by:

cancel in interface Future<T>

Parameters:

mayInterruptIfRunning - true if the thread executing this task should be interrupted; otherwise, in-progress tasks are allowed to complete

Returns:

false if the task could not be cancelled, typically because it has already completed normally; true otherwise

isCancelled

public boolean isCancelled()

Returns true if this task was cancelled before it completed normally.

Specified by:

isCancelled in interface Future<T>

Returns:

true if this task was cancelled before it completed

isDone

public final boolean isDone()

Returns true if this task completed.

Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true.

Specified by:

isDone in interface Future<T>

Returns:

true if this task completed

get

public final T get()
            throws InterruptedException,
ExecutionException

Waits if necessary for the computation to complete, and then retrieves its result.

Specified by:

get in interface Future<T>

Returns:

the computed result

Throws:

CancellationException - if the computation was cancelled

ExecutionException - if the computation threw an exception

InterruptedException - if the current thread was interrupted while waiting

get

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

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

Specified by:

get in interface Future<T>

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

the computed result

Throws:

CancellationException - if the computation was cancelled

ExecutionException - if the computation threw an exception

InterruptedException - if the current thread was interrupted while waiting

TimeoutException - if the wait timed out

getNow

public final T getNow()

Description copied from interface: AsyncFuture

Non-blocking variant of Future.get()

Specified by:

getNow in interface AsyncFuture<T>

Returns:

value or null

thenApply

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

Specified by:

thenApply in interface CompletionStage<T>

Overrides:

thenApply in class AbstractAsyncFuture<T>

thenApplyAsync

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

Specified by:

thenApplyAsync in interface CompletionStage<T>

Overrides:

thenApplyAsync in class AbstractAsyncFuture<T>

thenApplyAsync

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

Specified by:

thenApplyAsync in interface CompletionStage<T>

Overrides:

thenApplyAsync in class AbstractAsyncFuture<T>

thenAccept

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

Specified by:

thenAccept in interface CompletionStage<T>

Overrides:

thenAccept in class AbstractAsyncFuture<T>

thenAcceptAsync

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

Specified by:

thenAcceptAsync in interface CompletionStage<T>

Overrides:

thenAcceptAsync in class AbstractAsyncFuture<T>

thenAcceptAsync

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

Specified by:

thenAcceptAsync in interface CompletionStage<T>

Overrides:

thenAcceptAsync in class AbstractAsyncFuture<T>

thenRun

public CompletionStage<Void> thenRun(Runnable action)

Specified by:

thenRun in interface CompletionStage<T>

Overrides:

thenRun in class AbstractAsyncFuture<T>

thenRunAsync

public CompletionStage<Void> thenRunAsync(Runnable action)

Specified by:

thenRunAsync in interface CompletionStage<T>

Overrides:

thenRunAsync in class AbstractAsyncFuture<T>

thenRunAsync

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

Specified by:

thenRunAsync in interface CompletionStage<T>

Overrides:

thenRunAsync in class AbstractAsyncFuture<T>

thenCombine

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

Specified by:

thenCombine in interface CompletionStage<T>

Overrides:

thenCombine in class AbstractAsyncFuture<T>

thenCombineAsync

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

Specified by:

thenCombineAsync in interface CompletionStage<T>

Overrides:

thenCombineAsync in class AbstractAsyncFuture<T>

thenCombineAsync

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

Specified by:

thenCombineAsync in interface CompletionStage<T>

Overrides:

thenCombineAsync in class AbstractAsyncFuture<T>

thenAcceptBoth

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

Specified by:

thenAcceptBoth in interface CompletionStage<T>

Overrides:

thenAcceptBoth in class AbstractAsyncFuture<T>

thenAcceptBothAsync

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

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

Overrides:

thenAcceptBothAsync in class AbstractAsyncFuture<T>

thenAcceptBothAsync

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

Specified by:

thenAcceptBothAsync in interface CompletionStage<T>

Overrides:

thenAcceptBothAsync in class AbstractAsyncFuture<T>

runAfterBoth

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

Specified by:

runAfterBoth in interface CompletionStage<T>

Overrides:

runAfterBoth in class AbstractAsyncFuture<T>

runAfterBothAsync

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

Specified by:

runAfterBothAsync in interface CompletionStage<T>

Overrides:

runAfterBothAsync in class AbstractAsyncFuture<T>

runAfterBothAsync

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

Specified by:

runAfterBothAsync in interface CompletionStage<T>

Overrides:

runAfterBothAsync in class AbstractAsyncFuture<T>

applyToEither

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

Specified by:

applyToEither in interface CompletionStage<T>

Overrides:

applyToEither in class AbstractAsyncFuture<T>

applyToEitherAsync

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

Specified by:

applyToEitherAsync in interface CompletionStage<T>

Overrides:

applyToEitherAsync in class AbstractAsyncFuture<T>

applyToEitherAsync

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

Specified by:

applyToEitherAsync in interface CompletionStage<T>

Overrides:

applyToEitherAsync in class AbstractAsyncFuture<T>

acceptEither

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

Specified by:

acceptEither in interface CompletionStage<T>

Overrides:

acceptEither in class AbstractAsyncFuture<T>

acceptEitherAsync

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

Specified by:

acceptEitherAsync in interface CompletionStage<T>

Overrides:

acceptEitherAsync in class AbstractAsyncFuture<T>

acceptEitherAsync

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

Specified by:

acceptEitherAsync in interface CompletionStage<T>

Overrides:

acceptEitherAsync in class AbstractAsyncFuture<T>

runAfterEither

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

Specified by:

runAfterEither in interface CompletionStage<T>

Overrides:

runAfterEither in class AbstractAsyncFuture<T>

runAfterEitherAsync

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

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

Overrides:

runAfterEitherAsync in class AbstractAsyncFuture<T>

runAfterEitherAsync

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

Specified by:

runAfterEitherAsync in interface CompletionStage<T>

Overrides:

runAfterEitherAsync in class AbstractAsyncFuture<T>

thenCompose

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

Specified by:

thenCompose in interface CompletionStage<T>

Overrides:

thenCompose in class AbstractAsyncFuture<T>

thenComposeAsync

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

Specified by:

thenComposeAsync in interface CompletionStage<T>

Overrides:

thenComposeAsync in class AbstractAsyncFuture<T>

thenComposeAsync

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

Specified by:

thenComposeAsync in interface CompletionStage<T>

Overrides:

thenComposeAsync in class AbstractAsyncFuture<T>

toCompletableFuture

public CompletableFuture<T> toCompletableFuture()

Specified by:

toCompletableFuture in interface CompletionStage<T>