Class SucceededFuture<V>

java.lang.Object

io.netty.util.concurrent.AbstractFuture<V>

io.netty.util.concurrent.CompleteFuture<V>

io.netty.util.concurrent.SucceededFuture<V>

All Implemented Interfaces:

Future<V>, Future<V>

public final class SucceededFuture<V>
extends CompleteFuture<V>

The CompleteFuture which is succeeded already. It is recommended to use EventExecutor.newSucceededFuture(Object) instead of calling the constructor of this future.

Constructor Summary

Constructors

Constructor	Description
SucceededFuture(EventExecutor executor, V result)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
Throwable	cause()	Returns the cause of the failed I/O operation if the I/O operation has failed.
V	getNow()	Return the result without blocking.
boolean	isSuccess()	Returns true if and only if the I/O operation was completed successfully.

Methods inherited from class CompleteFuture

addListener, addListeners, await, await, await, awaitUninterruptibly, awaitUninterruptibly, awaitUninterruptibly, cancel, executor, isCancellable, isCancelled, isDone, removeListener, removeListeners, sync, syncUninterruptibly

Modifier and Type	Method	Description
Future<V>	addListener(GenericFutureListener<? extends Future<? super V>> listener)	Adds the specified listener to this future.
Future<V>	addListeners(GenericFutureListener<? extends Future<? super V>>... listeners)	Adds the specified listeners to this future.
Future<V>	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.
Future<V>	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)	If the cancellation was successful it will fail the future with a CancellationException.
protected EventExecutor	executor()	Return the EventExecutor which is used by this CompleteFuture.
boolean	isCancellable()	returns true if and only if the operation can be cancelled via Future.cancel(boolean).
boolean	isCancelled()
boolean	isDone()
Future<V>	removeListener(GenericFutureListener<? extends Future<? super V>> listener)	Removes the first occurrence of the specified listener from this future.
Future<V>	removeListeners(GenericFutureListener<? extends Future<? super V>>... listeners)	Removes the first occurrence for each of the listeners from this future.
Future<V>	sync()	Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
Future<V>	syncUninterruptibly()	Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Methods inherited from class AbstractFuture

get, get

Modifier and Type	Method	Description
V	get()
V	get(long timeout, TimeUnit unit)

Methods inherited from class Object

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

Constructor Details

SucceededFuture

public SucceededFuture(EventExecutor executor,
 V result)

Creates a new instance.

Parameters:

executor - the EventExecutor associated with this future

Method Details

cause

public Throwable cause()

Description copied from interface: Future

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

Returns:

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

isSuccess

public boolean isSuccess()

Description copied from interface: Future

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

getNow

public V getNow()

Description copied from interface: Future

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 rely on the returned null value.