org.snf4j.core.future

Class CompletedFuture<V>

java.lang.Object

org.snf4j.core.future.AbstractFuture<V>

org.snf4j.core.future.CompletedFuture<V>

All Implemented Interfaces:

Future<V>, IFuture<V>

Direct Known Subclasses:

CancelledFuture, FailedFuture, SuccessfulFuture

public class CompletedFuture<V>
extends AbstractFuture<V>

A completed future.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Constructor and Description
CompletedFuture(ISession session, org.snf4j.core.future.FutureState state) Constructs a completed future with the specified session.

Method Summary

Modifier and Type	Method and Description
IFuture<V>	await() Returns immediately
IFuture<V>	await(long timeoutMillis) Returns immediately
IFuture<V>	await(long timeout, TimeUnit unit) Returns immediately
IFuture<V>	awaitUninterruptibly() Returns immediately
IFuture<V>	awaitUninterruptibly(long timeoutMillis) Returns immediately
IFuture<V>	awaitUninterruptibly(long timeout, TimeUnit unit) Returns immediately
boolean	cancel(boolean arg0) Does nothing.
Throwable	cause() Returns null
V	get() Returns immediately
V	get(long arg0, TimeUnit arg1) Returns immediately
boolean	isDone() Tells that this future is completed
IFuture<V>	sync() Returns immediately
IFuture<V>	sync(long timeoutMillis) Returns immediately
IFuture<V>	sync(long timeout, TimeUnit unit) Returns immediately
IFuture<V>	syncUninterruptibly() Returns immediately
IFuture<V>	syncUninterruptibly(long timeoutMillis) Returns immediately
IFuture<V>	syncUninterruptibly(long timeout, TimeUnit unit) Returns immediately

Methods inherited from class org.snf4j.core.future.AbstractFuture

getNow, getSession, isCancelled, isFailed, isSuccessful, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CompletedFuture

public CompletedFuture(ISession session,
                       org.snf4j.core.future.FutureState state)

Constructs a completed future with the specified session.

Parameters:

session - the session this future is associated with

state - the state of this future

Throws:

IllegalArgumentException - if the state argument is null

Method Detail

cancel

public boolean cancel(boolean arg0)

Does nothing.

Returns:

true

get

public V get()
      throws InterruptedException,
             ExecutionException

Returns immediately

Returns:

null

Throws:

InterruptedException

ExecutionException

get

public V get(long arg0,
             TimeUnit arg1)
      throws InterruptedException,
             ExecutionException,
             TimeoutException

Returns immediately

Returns:

null

Throws:

InterruptedException

ExecutionException

TimeoutException

isDone

public boolean isDone()

Tells that this future is completed

Specified by:

isDone in interface Future<V>

Overrides:

isDone in class AbstractFuture<V>

Returns:

true

await

public IFuture<V> await()

Returns immediately

Returns:

this future

await

public IFuture<V> await(long timeoutMillis)

Returns immediately

Parameters:

timeoutMillis - the time limit in milliseconds to wait

Returns:

this future

await

public IFuture<V> await(long timeout,
                        TimeUnit unit)

Returns immediately

Parameters:

timeout - the time limit to wait

unit - the time unit of the time limit

Returns:

this future

awaitUninterruptibly

public IFuture<V> awaitUninterruptibly()

Returns immediately

Returns:

this future

awaitUninterruptibly

public IFuture<V> awaitUninterruptibly(long timeoutMillis)

Returns immediately

Parameters:

timeoutMillis - the time limit in milliseconds to wait

Returns:

this future

awaitUninterruptibly

public IFuture<V> awaitUninterruptibly(long timeout,
                                       TimeUnit unit)

Returns immediately

Parameters:

timeout - the time limit to wait

unit - the time unit of the time limit

Returns:

this future

sync

public IFuture<V> sync()

Returns immediately

Returns:

this future

sync

public IFuture<V> sync(long timeoutMillis)

Returns immediately

Parameters:

timeoutMillis - the time limit in milliseconds to wait

Returns:

this future

sync

public IFuture<V> sync(long timeout,
                       TimeUnit unit)

Returns immediately

Parameters:

timeout - the time limit to wait

unit - the time unit of the time limit

Returns:

this future

syncUninterruptibly

public IFuture<V> syncUninterruptibly()

Returns immediately

Returns:

this future

syncUninterruptibly

public IFuture<V> syncUninterruptibly(long timeoutMillis)

Returns immediately

Parameters:

timeoutMillis - the time limit in milliseconds to wait

Returns:

this future

syncUninterruptibly

public IFuture<V> syncUninterruptibly(long timeout,
                                      TimeUnit unit)

Returns immediately

Parameters:

timeout - the time limit to wait

unit - the time unit of the time limit

Returns:

this future

cause

public Throwable cause()

Returns null

Returns:

null