org.redisson.misc

Class RedissonPromise<T>

java.lang.Object

java.util.concurrent.CompletableFuture<T>

org.redisson.misc.RedissonPromise<T>

Type Parameters:

T - type of object

All Implemented Interfaces:

CompletionStage<T>, Future<T>, RFuture<T>, RPromise<T>

Direct Known Subclasses:

BatchPromise, RedissonExecutorBatchFuture, RemotePromise

public class RedissonPromise<T>
extends CompletableFuture<T>
implements RPromise<T>

Author:

Nikita Koksharov

Nested Class Summary

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

CompletableFuture.AsynchronousCompletionTask

Constructor Summary

Constructors

Constructor and Description
RedissonPromise()

Method Summary

Modifier and Type	Method and Description
RPromise<T>	addListener(io.netty.util.concurrent.FutureListener<? super T> listener) Use methods from CompletionStage interface
RPromise<T>	addListeners(io.netty.util.concurrent.FutureListener<? super T>... listeners) Use methods from CompletionStage interface
RPromise<T>	await() Waits for this future to be completed.
boolean	await(long timeoutMillis) Waits for this future to be completed within the specified time limit.
boolean	await(long timeout, TimeUnit unit) Waits for this future to be completed within the specified time limit.
RPromise<T>	awaitUninterruptibly() Waits for this future to be completed without interruption.
boolean	awaitUninterruptibly(long timeoutMillis) Waits for this future to be completed within the specified time limit without interruption.
boolean	awaitUninterruptibly(long timeout, TimeUnit unit) Waits for this future to be completed within the specified time limit without interruption.
boolean	cancel(boolean mayInterruptIfRunning)
Throwable	cause() Returns the cause of the failed I/O operation if the I/O operation has failed.
T	getNow() Return the result without blocking.
boolean	hasListeners()
boolean	isSuccess() Returns true if and only if the I/O operation was completed successfully.
static <V> RFuture<V>	newFailedFuture(Throwable cause)
static <V> RFuture<V>	newSucceededFuture(V result)
RPromise<T>	removeListener(io.netty.util.concurrent.FutureListener<? super T> listener)
RPromise<T>	removeListeners(io.netty.util.concurrent.FutureListener<? super T>... listeners)
boolean	setUncancellable() Make this future impossible to cancel.
RPromise<T>	sync() Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
RPromise<T>	syncUninterruptibly() Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
String	toString()
boolean	tryFailure(Throwable cause) Marks this future as a failure and notifies all listeners.
boolean	trySuccess(T result) Marks this future as a success and notifies all listeners.

Methods inherited from class java.util.concurrent.CompletableFuture

acceptEither, acceptEitherAsync, acceptEitherAsync, allOf, anyOf, applyToEither, applyToEitherAsync, applyToEitherAsync, complete, completedFuture, completeExceptionally, exceptionally, get, get, getNow, getNumberOfDependents, handle, handleAsync, handleAsync, isCancelled, isCompletedExceptionally, isDone, join, obtrudeException, obtrudeValue, 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, whenComplete, whenCompleteAsync, whenCompleteAsync

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.redisson.api.RFuture

join

Methods inherited from interface java.util.concurrent.Future

get, get, isCancelled, isDone

Methods inherited from interface java.util.concurrent.CompletionStage

acceptEither, acceptEitherAsync, acceptEitherAsync, applyToEither, applyToEitherAsync, applyToEitherAsync, exceptionally, handle, handleAsync, handleAsync, runAfterBoth, runAfterBothAsync, runAfterBothAsync, runAfterEither, runAfterEitherAsync, runAfterEitherAsync, thenAccept, thenAcceptAsync, thenAcceptAsync, thenAcceptBoth, thenAcceptBothAsync, thenAcceptBothAsync, thenApply, thenApplyAsync, thenApplyAsync, thenCombine, thenCombineAsync, thenCombineAsync, thenCompose, thenComposeAsync, thenComposeAsync, thenRun, thenRunAsync, thenRunAsync, toCompletableFuture, whenComplete, whenCompleteAsync, whenCompleteAsync

Constructor Detail

RedissonPromise

public RedissonPromise()

Method Detail

newFailedFuture

public static <V> RFuture<V> newFailedFuture(Throwable cause)

newSucceededFuture

public static <V> RFuture<V> newSucceededFuture(V result)

isSuccess

public boolean isSuccess()

Description copied from interface: RFuture

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

Specified by:

isSuccess in interface RFuture<T>

Returns:

true if future was completed successfully

trySuccess

public boolean trySuccess(T result)

Description copied from interface: RPromise

Marks this future as a success and notifies all listeners.

Specified by:

trySuccess in interface RPromise<T>

Parameters:

result - object

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.

cause

public Throwable cause()

Description copied from interface: RFuture

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

Specified by:

cause in interface RFuture<T>

Returns:

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

tryFailure

public boolean tryFailure(Throwable cause)

Description copied from interface: RPromise

Marks this future as a failure and notifies all listeners.

Specified by:

tryFailure in interface RPromise<T>

Parameters:

cause - object

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.

setUncancellable

public boolean setUncancellable()

Description copied from interface: RPromise

Make this future impossible to cancel.

Specified by:

setUncancellable in interface RPromise<T>

Returns:

true if and only if successfully marked this future as uncancellable or it is already done without being cancelled. false if this future has been cancelled already.

addListener

public RPromise<T> addListener(io.netty.util.concurrent.FutureListener<? super T> listener)

Description copied from interface: RFuture

Use methods from CompletionStage interface

Specified by:

addListener in interface RFuture<T>

Specified by:

addListener in interface RPromise<T>

Parameters:

listener - - listener for future object

Returns:

Future object

addListeners

public RPromise<T> addListeners(io.netty.util.concurrent.FutureListener<? super T>... listeners)

Description copied from interface: RFuture

Use methods from CompletionStage interface

Specified by:

addListeners in interface RFuture<T>

Specified by:

addListeners in interface RPromise<T>

Parameters:

listeners - - listeners for future object

Returns:

Future object

removeListener

public RPromise<T> removeListener(io.netty.util.concurrent.FutureListener<? super T> listener)

Specified by:

removeListener in interface RFuture<T>

Specified by:

removeListener in interface RPromise<T>

removeListeners

public RPromise<T> removeListeners(io.netty.util.concurrent.FutureListener<? super T>... listeners)

Specified by:

removeListeners in interface RFuture<T>

Specified by:

removeListeners in interface RPromise<T>

await

public RPromise<T> await()
                  throws InterruptedException

Description copied from interface: RFuture

Waits for this future to be completed.

Specified by:

await in interface RFuture<T>

Specified by:

await in interface RPromise<T>

Returns:

Future object

Throws:

InterruptedException - if the current thread was interrupted

awaitUninterruptibly

public RPromise<T> awaitUninterruptibly()

Description copied from interface: RFuture

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

Specified by:

awaitUninterruptibly in interface RFuture<T>

Specified by:

awaitUninterruptibly in interface RPromise<T>

Returns:

Future object

sync

public RPromise<T> sync()
                 throws InterruptedException

Description copied from interface: RFuture

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Specified by:

sync in interface RFuture<T>

Specified by:

sync in interface RPromise<T>

Returns:

Future object

Throws:

InterruptedException - if the current thread was interrupted

syncUninterruptibly

public RPromise<T> syncUninterruptibly()

Description copied from interface: RFuture

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Specified by:

syncUninterruptibly in interface RFuture<T>

Specified by:

syncUninterruptibly in interface RPromise<T>

Returns:

Future object

await

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

Description copied from interface: RFuture

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

Specified by:

await in interface RFuture<T>

Parameters:

timeout - - wait timeout

unit - - time unit

Returns:

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

Throws:

InterruptedException - if the current thread was interrupted

await

public boolean await(long timeoutMillis)
              throws InterruptedException

Description copied from interface: RFuture

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

Specified by:

await in interface RFuture<T>

Parameters:

timeoutMillis - - timeout value

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 boolean awaitUninterruptibly(long timeout,
                                    TimeUnit unit)

Description copied from interface: RFuture

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 RFuture<T>

Parameters:

timeout - - timeout value

unit - - timeout unit value

Returns:

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

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeoutMillis)

Description copied from interface: RFuture

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 RFuture<T>

Parameters:

timeoutMillis - - timeout value

Returns:

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

getNow

public T getNow()

Description copied from interface: RFuture

Return the result without blocking. If the future is not done yet this will return null. As it is possible that a null value is used to mark the future as successful you also need to check if the future is really done with Future.isDone() and not relay on the returned null value.

Specified by:

getNow in interface RFuture<T>

Returns:

object

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<T>

Overrides:

cancel in class CompletableFuture<T>

hasListeners

public boolean hasListeners()

Specified by:

hasListeners in interface RPromise<T>

toString

public String toString()

Overrides:

toString in class CompletableFuture<T>