java.lang.Object
org.xnio.FinishedIoFuture<T>
- Type Parameters:
T
- the type of result that this operation produces
- All Implemented Interfaces:
Cancellable
,IoFuture<T>
An implementation of
IoFuture
that represents an immediately-successful operation.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.xnio.IoFuture
IoFuture.HandlingNotifier<T,
A>, IoFuture.Notifier<T, A>, IoFuture.Status -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddNotifier
(IoFuture.Notifier<? super T, A> notifier, A attachment) Add a notifier to be called when this operation is complete.await()
Wait for the operation to complete.Wait for the operation to complete, with a timeout.Wait for the operation to complete.awaitInterruptibly
(long time, TimeUnit timeUnit) Wait for the operation to complete, with a timeout.cancel()
Cancel the operation.get()
Get the result of the operation.Get the failure reason.Get the result of the operation.Get the current status.
-
Constructor Details
-
FinishedIoFuture
Create an instance.- Parameters:
result
- the operation result
-
-
Method Details
-
cancel
Cancel the operation. Since this operation is always complete, this is a no-op.- Specified by:
cancel
in interfaceCancellable
- Specified by:
cancel
in interfaceIoFuture<T>
- Returns:
- this instance
-
getStatus
Description copied from interface:IoFuture
Get the current status. -
await
Description copied from interface:IoFuture
Wait for the operation to complete. This method will block until the status changes fromIoFuture.Status.WAITING
. -
await
Description copied from interface:IoFuture
Wait for the operation to complete, with a timeout. This method will block until the status changes fromIoFuture.Status.WAITING
, or the given time elapses. If the time elapses before the operation is complete,IoFuture.Status.WAITING
is returned.- Specified by:
await
in interfaceIoFuture<T>
- Parameters:
time
- the amount of time to waittimeUnit
- the time unit- Returns:
- the new status, or
IoFuture.Status.WAITING
if the timeout expired
-
awaitInterruptibly
Description copied from interface:IoFuture
Wait for the operation to complete. This method will block until the status changes fromIoFuture.Status.WAITING
, or the current thread is interrupted.- Specified by:
awaitInterruptibly
in interfaceIoFuture<T>
- Returns:
- the new status
- Throws:
InterruptedException
- if the operation is interrupted
-
awaitInterruptibly
Description copied from interface:IoFuture
Wait for the operation to complete, with a timeout. This method will block until the status changes fromIoFuture.Status.WAITING
, the given time elapses, or the current thread is interrupted. If the time elapses before the operation is complete,IoFuture.Status.WAITING
is returned.- Specified by:
awaitInterruptibly
in interfaceIoFuture<T>
- Parameters:
time
- the amount of time to waittimeUnit
- the time unit- Returns:
- the new status, or
IoFuture.Status.WAITING
if the timeout expired - Throws:
InterruptedException
- if the operation is interrupted
-
get
Description copied from interface:IoFuture
Get the result of the operation. If the operation is not complete, blocks until the operation completes. If the operation fails, or has already failed at the time this method is called, the failure reason is thrown.- Specified by:
get
in interfaceIoFuture<T>
- Returns:
- the result of the operation
- Throws:
IOException
- if the operation failedCancellationException
- if the operation was cancelled
-
getInterruptibly
Description copied from interface:IoFuture
Get the result of the operation. If the operation is not complete, blocks until the operation completes. If the operation fails, or has already failed at the time this method is called, the failure reason is thrown. If the current thread is interrupted while waiting, an exception is thrown.- Specified by:
getInterruptibly
in interfaceIoFuture<T>
- Returns:
- the result of the operation
- Throws:
IOException
- if the operation failedInterruptedException
- if the operation is interruptedCancellationException
- if the operation was cancelled
-
getException
Description copied from interface:IoFuture
Get the failure reason.- Specified by:
getException
in interfaceIoFuture<T>
- Returns:
- the failure reason
- Throws:
IllegalStateException
- if the operation did not fail
-
addNotifier
Description copied from interface:IoFuture
Add a notifier to be called when this operation is complete. If the operation is already complete, the notifier is called immediately, possibly in the caller's thread. The given attachment is provided to the notifier.- Specified by:
addNotifier
in interfaceIoFuture<T>
- Type Parameters:
A
- the attachment type- Parameters:
notifier
- the notifier to be calledattachment
- the attachment to pass in to the notifier- Returns:
- this instance
-