Package com.linecorp.armeria.common.util

Class UnmodifiableFuture<T>

java.lang.Object

java.util.concurrent.CompletableFuture<T>

com.linecorp.armeria.common.util.EventLoopCheckingFuture<T>

com.linecorp.armeria.common.util.UnmodifiableFuture<T>

All Implemented Interfaces:

CompletionStage<T>, Future<T>

public class UnmodifiableFuture<T>
extends EventLoopCheckingFuture<T>

A CompletableFuture which prevents the caller from completing it. An attempt to call any of the following methods will trigger an UnsupportedOperationException:

• complete(Object)
• completeExceptionally(Throwable)
• obtrudeValue(Object)
• obtrudeException(Throwable)

Also, cancel(boolean) will do nothing but returning whether cancelled or not.

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.CompletableFuture

CompletableFuture.AsynchronousCompletionTask

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UnmodifiableFuture()	Creates a new UnmodifiableFuture.

Method Summary

Modifier and Type	Method	Description
boolean	cancel(boolean mayInterruptIfRunning)	Does nothing but returning whether this future has been cancelled or not.
boolean	complete(T value)	Throws an UnsupportedOperationException.
static <U> UnmodifiableFuture<U>	completedFuture(U value)	Returns an UnmodifiableFuture which has been completed with the specified value.
boolean	completeExceptionally(Throwable ex)	Throws an UnsupportedOperationException.
protected boolean	doCancel()	Completes this CompletableFuture with a CancellationException, unless already completed.
protected void	doComplete(T value)	Completes with a non-exceptional @{code value}, unless already completed.
protected void	doCompleteExceptionally(Throwable cause)	Completes with the specified Throwable, unless already completed.
static <U> UnmodifiableFuture<U>	exceptionallyCompletedFuture(Throwable cause)	Returns an UnmodifiableFuture which has been completed exceptionally with the specified Throwable.
void	obtrudeException(Throwable ex)	Throws an UnsupportedOperationException.
void	obtrudeValue(T value)	Throws an UnsupportedOperationException.
static <U> UnmodifiableFuture<U>	wrap(CompletableFuture<U> future)	Returns an UnmodifiableFuture which will be completed when the specified CompletableFuture is completed.

Methods inherited from class com.linecorp.armeria.common.util.EventLoopCheckingFuture

get, get, join

Methods inherited from class java.util.concurrent.CompletableFuture

acceptEither, acceptEitherAsync, acceptEitherAsync, allOf, anyOf, applyToEither, applyToEitherAsync, applyToEitherAsync, completeAsync, completeAsync, completedStage, completeOnTimeout, copy, defaultExecutor, delayedExecutor, delayedExecutor, exceptionally, exceptionallyAsync, exceptionallyAsync, exceptionallyCompose, exceptionallyComposeAsync, exceptionallyComposeAsync, failedFuture, failedStage, getNow, getNumberOfDependents, handle, handleAsync, handleAsync, isCancelled, isCompletedExceptionally, isDone, minimalCompletionStage, newIncompleteFuture, orTimeout, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, runAsync, runAsync, 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

Methods inherited from class java.lang.Object

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

Constructor Details

UnmodifiableFuture

protected UnmodifiableFuture()

Creates a new UnmodifiableFuture.

Method Details

completedFuture

public static <U> UnmodifiableFuture<U> completedFuture(@Nullable U value)

Returns an UnmodifiableFuture which has been completed with the specified value.

exceptionallyCompletedFuture

public static <U> UnmodifiableFuture<U> exceptionallyCompletedFuture(Throwable cause)

Returns an UnmodifiableFuture which has been completed exceptionally with the specified Throwable.

wrap

public static <U> UnmodifiableFuture<U> wrap(CompletableFuture<U> future)

Returns an UnmodifiableFuture which will be completed when the specified CompletableFuture is completed.

complete

public boolean complete(@Nullable T value)

Throws an UnsupportedOperationException.

Overrides:

complete in class CompletableFuture<T>

doComplete

protected void doComplete(@Nullable T value)

Completes with a non-exceptional @{code value}, unless already completed.

completeExceptionally

public boolean completeExceptionally(Throwable ex)

Throws an UnsupportedOperationException.

Overrides:

completeExceptionally in class CompletableFuture<T>

doCompleteExceptionally

protected void doCompleteExceptionally(Throwable cause)

Completes with the specified Throwable, unless already completed.

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Does nothing but returning whether this future has been cancelled or not.

Specified by:

cancel in interface Future<T>

Overrides:

cancel in class CompletableFuture<T>

doCancel

protected boolean doCancel()

Completes this CompletableFuture with a CancellationException, unless already completed.

obtrudeValue

public void obtrudeValue(@Nullable T value)

Throws an UnsupportedOperationException.

Overrides:

obtrudeValue in class CompletableFuture<T>

obtrudeException

public void obtrudeException(Throwable ex)

Throws an UnsupportedOperationException.

Overrides:

obtrudeException in class CompletableFuture<T>