CompleteFuture (Netty API Reference (4.1.115.Final))

java.lang.Object
- io.netty.util.concurrent.AbstractFuture<V>
- - io.netty.util.concurrent.CompleteFuture<V>

All Implemented Interfaces:

Future<V>

Direct Known Subclasses:

FailedFuture, SucceededFuture
```
public abstract class CompleteFuture<V>
extends AbstractFuture<V>
```
A skeletal Future implementation which represents a Future which has been completed already.

Constructor Summary

Constructors
Modifier Constructor and Description

protected CompleteFuture(EventExecutor executor)
Creates a new instance.

Constructors
Modifier	Constructor and Description
`protected`	`CompleteFuture(EventExecutor executor)` Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 io.netty.util.concurrent.AbstractFuture
get, get

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.util.concurrent.Future
cause, getNow, isSuccess

- Constructor Detail
  - CompleteFuture
```
protected CompleteFuture(EventExecutor executor)
```
    Creates a new instance.
    
    Parameters:
    
    executor - the EventExecutor associated with this future
- Method Detail
  - executor
```
protected EventExecutor executor()
```
    Return the EventExecutor which is used by this CompleteFuture.
  - addListener
```
public Future<V> addListener(GenericFutureListener<? extends Future<? super V>> listener)
```
    Description copied from interface: Future
    
    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.
  - addListeners
```
public Future<V> addListeners(GenericFutureListener<? extends Future<? super V>>... listeners)
```
    Description copied from interface: Future
    
    Adds the specified listeners to this future. The specified listeners are notified when this future is done. If this future is already completed, the specified listeners are notified immediately.
  - removeListener
```
public Future<V> removeListener(GenericFutureListener<? extends Future<? super V>> listener)
```
    Description copied from interface: Future
    
    Removes the first occurrence of the specified listener from this future. The specified listener is no longer notified when this future is done. If the specified listener is not associated with this future, this method does nothing and returns silently.
  - removeListeners
```
public Future<V> removeListeners(GenericFutureListener<? extends Future<? super V>>... listeners)
```
    Description copied from interface: Future
    
    Removes the first occurrence for each of the listeners from this future. The specified listeners are no longer notified when this future is done. If the specified listeners are not associated with this future, this method does nothing and returns silently.
  - await
```
public Future<V> await()
                throws InterruptedException
```
    Description copied from interface: Future
    
    Waits for this future to be completed.
    
    Throws:
    
    InterruptedException - if the current thread was interrupted
  - await
```
public boolean await(long timeout,
                     TimeUnit unit)
              throws InterruptedException
```
    Description copied from interface: Future
    
    Waits for this future to be completed within the specified time limit.
    
    Returns:
    
    true if and only if the future was completed within the specified time limit
    
    Throws:
    
    InterruptedException - if the current thread was interrupted
  - sync
```
public Future<V> sync()
               throws InterruptedException
```
    Description copied from interface: Future
    
    Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
    
    Throws:
    
    InterruptedException
  - syncUninterruptibly
```
public Future<V> syncUninterruptibly()
```
    Description copied from interface: Future
    
    Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
  - await
```
public boolean await(long timeoutMillis)
              throws InterruptedException
```
    Description copied from interface: Future
    
    Waits for this future to be completed within the specified time limit.
    
    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 Future<V> awaitUninterruptibly()
```
    Description copied from interface: Future
    
    Waits for this future to be completed without interruption. This method catches an InterruptedException and discards it silently.
  - awaitUninterruptibly
```
public boolean awaitUninterruptibly(long timeout,
                                    TimeUnit unit)
```
    Description copied from interface: Future
    
    Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.
    
    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: Future
    
    Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.
    
    Returns:
    
    true if and only if the future was completed within the specified time limit
  - isDone
```
public boolean isDone()
```
  - isCancellable
```
public boolean isCancellable()
```
    Description copied from interface: Future
    
    returns true if and only if the operation can be cancelled via Future.cancel(boolean).
  - isCancelled
```
public boolean isCancelled()
```
  - cancel
```
public boolean cancel(boolean mayInterruptIfRunning)
```
    If the cancellation was successful it will fail the future with a CancellationException.
    
    Parameters:
    
    mayInterruptIfRunning - this value has no effect in this implementation.

Class CompleteFuture<V>

Constructor Summary

Method Summary

Methods inherited from class io.netty.util.concurrent.AbstractFuture

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.util.concurrent.Future

Constructor Detail

CompleteFuture

Method Detail

executor

addListener

addListeners

removeListener

removeListeners

await

await

sync

syncUninterruptibly

await

awaitUninterruptibly

awaitUninterruptibly

awaitUninterruptibly

isDone

isCancellable

isCancelled

cancel