CompletePromise (Netty/Common 4.0.0.CR9 API)

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

All Implemented Interfaces:: Promise<V>, Future<V>

public abstract class CompletePromise<V>
extends CompleteFuture<V>
implements Promise<V>

Constructor Summary

Constructors
Modifier Constructor and Description

protected CompletePromise(EventExecutor executor)

Constructors
Modifier	Constructor and Description
`protected`	`CompletePromise(EventExecutor executor)`

Method Summary

Methods
Modifier and Type	Method and Description
`Promise<V>`	`addListener(GenericFutureListener<? extends Future<? super V>> listener)` Adds the specified listener to this future.
`Promise<V>`	`addListeners(GenericFutureListener<? extends Future<? super V>>... listeners)` Adds the specified listeners to this future.
`Promise<V>`	`await()` Waits for this future to be completed.
`Promise<V>`	`awaitUninterruptibly()` Waits for this future to be completed without interruption.
`Promise<V>`	`removeListener(GenericFutureListener<? extends Future<? super V>> listener)` Removes the specified listener from this future.
`Promise<V>`	`removeListeners(GenericFutureListener<? extends Future<? super V>>... listeners)` Removes the specified listeners from this future.
`Promise<V>`	`setFailure(Throwable cause)` Marks this future as a failure and notifies all listeners.
`Promise<V>`	`setSuccess(V result)` Marks this future as a success and notifies all listeners.
`Promise<V>`	`sync()` Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
`Promise<V>`	`syncUninterruptibly()` Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
`boolean`	`tryFailure(Throwable cause)` Marks this future as a failure and notifies all listeners.
`boolean`	`trySuccess(V result)` Marks this future as a success and notifies all listeners.

Methods inherited from class io.netty.util.concurrent.CompleteFuture
await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, executor, isCancellable, isCancelled, isDone

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.Promise
setUncancellable

Methods inherited from interface io.netty.util.concurrent.Future
await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, getNow, isCancellable, isSuccess

Methods inherited from interface java.util.concurrent.Future
get, get, isCancelled, isDone

- Constructor Detail
  - CompletePromise
```
protected CompletePromise(EventExecutor executor)
```
- Method Detail
  - setFailure
```
public Promise<V> setFailure(Throwable cause)
```
    Description copied from interface: Promise
    
    Marks this future as a failure and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.
    
    Specified by:
    
    setFailure in interface Promise<V>
  - tryFailure
```
public boolean tryFailure(Throwable cause)
```
    Description copied from interface: Promise
    
    Marks this future as a failure and notifies all listeners.
    
    Specified by:
    
    tryFailure in interface Promise<V>
    
    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.
  - setSuccess
```
public Promise<V> setSuccess(V result)
```
    Description copied from interface: Promise
    
    Marks this future as a success and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.
    
    Specified by:
    
    setSuccess in interface Promise<V>
  - trySuccess
```
public boolean trySuccess(V result)
```
    Description copied from interface: Promise
    
    Marks this future as a success and notifies all listeners.
    
    Specified by:
    
    trySuccess in interface Promise<V>
    
    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.
  - await
```
public Promise<V> await()
                 throws InterruptedException
```
    Description copied from interface: Future
    
    Waits for this future to be completed.
    
    Specified by:
    
    await in interface Promise<V>
    
    Overrides:
    
    await in class CompleteFuture<V>
    
    Throws:
    
    InterruptedException - if the current thread was interrupted
  - awaitUninterruptibly
```
public Promise<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.
    
    Specified by:
    
    awaitUninterruptibly in interface Promise<V>
    
    Overrides:
    
    awaitUninterruptibly in class CompleteFuture<V>
  - syncUninterruptibly
```
public Promise<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.
    
    Specified by:
    
    syncUninterruptibly in interface Promise<V>
    
    Overrides:
    
    syncUninterruptibly in class CompleteFuture<V>
  - sync
```
public Promise<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.
    
    Specified by:
    
    sync in interface Promise<V>
    
    Overrides:
    
    sync in class CompleteFuture<V>
    
    Throws:
    
    InterruptedException
  - addListener
```
public Promise<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.
    
    Specified by:
    
    addListener in interface Promise<V>
    
    Overrides:
    
    addListener in class CompleteFuture<V>
  - addListeners
```
public Promise<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.
    
    Specified by:
    
    addListeners in interface Promise<V>
    
    Overrides:
    
    addListeners in class CompleteFuture<V>
  - removeListener
```
public Promise<V> removeListener(GenericFutureListener<? extends Future<? super V>> listener)
```
    Description copied from interface: Future
    
    Removes 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.
    
    Specified by:
    
    removeListener in interface Promise<V>
    
    Overrides:
    
    removeListener in class CompleteFuture<V>
  - removeListeners
```
public Promise<V> removeListeners(GenericFutureListener<? extends Future<? super V>>... listeners)
```
    Description copied from interface: Future
    
    Removes the specified 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.
    
    Specified by:
    
    removeListeners in interface Promise<V>
    
    Overrides:
    
    removeListeners in class CompleteFuture<V>

Class CompletePromise<V>

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface java.util.concurrent.Future

Constructor Detail

CompletePromise

Method Detail

setFailure

tryFailure

setSuccess

trySuccess

await

awaitUninterruptibly

syncUninterruptibly

sync

addListener

addListeners

removeListener

removeListeners