to.etc.util

Class FutureValueNB<T>

java.lang.Object

to.etc.util.FutureValueNB<T>

All Implemented Interfaces:

Future<T>

public class FutureValueNB<T>
extends Object
implements Future<T>

Basic non-blocking Implementation of Future<T> which immediately aborts on get() if no value is provided.

Author:

Frits Jalvingh Created on Mar 14, 2013

Constructor Summary

Constructors

Constructor and Description
FutureValueNB()
FutureValueNB(Exception error) Create a future that's already done, with the specified error.
FutureValueNB(String description)
FutureValueNB(String description, T result)
FutureValueNB(T result) Create a future that's already done, with the specified result.

Method Summary

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning)
T	get() Get the result, wait if it's not yet available.
T	get(long timeout, TimeUnit unit)
boolean	isCancelled()
boolean	isDone()
void	set(Exception reason) Mark the future as ready, but aborted with an exception.
void	set(T value) Return the result, and notify any waiters.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FutureValueNB

public FutureValueNB()

FutureValueNB

public FutureValueNB(@Nullable
                     String description)

FutureValueNB

public FutureValueNB(@Nullable
                     T result)

Create a future that's already done, with the specified result.

Parameters:

result -

FutureValueNB

public FutureValueNB(@Nullable
                     String description,
                     @Nullable
                     T result)

FutureValueNB

public FutureValueNB(@Nonnull
                     Exception error)

Create a future that's already done, with the specified error.

Parameters:

error -

Method Detail

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface Future<T>

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<T>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<T>

get

public T get()
      throws InterruptedException,
             ExecutionException

Get the result, wait if it's not yet available.

Specified by:

get in interface Future<T>

Throws:

InterruptedException

ExecutionException

See Also:

Future.get()

get

public T get(long timeout,
             TimeUnit unit)
      throws InterruptedException,
             ExecutionException,
             TimeoutException

Specified by:

get in interface Future<T>

Throws:

InterruptedException

ExecutionException

TimeoutException

set

public void set(@Nullable
                T value)

Return the result, and notify any waiters.

Parameters:

value -

set

public void set(@Nonnull
                Exception reason)

Mark the future as ready, but aborted with an exception.

Parameters:

reason -

toString

public String toString()

Overrides:

toString in class Object