rsb.patterns

Class Future<T>

java.lang.Object

rsb.patterns.Future<T>

All Implemented Interfaces:

java.util.concurrent.Future<T>

public class Future<T>
extends java.lang.Object
implements java.util.concurrent.Future<T>

This class provides an implementation of Java's Future interface for use with request invocations.

Author:

jschaefe, swrede, jmoringe

See Also:

Future

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cancelled
protected java.lang.Throwable	exception
protected boolean	hasResult
protected T	result

Constructor Summary

Constructors

Constructor and Description
Future()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterrupt) This method makes the waiting thread return with a CancellationException but does not cancel the actual operation the thread was waiting for.
void	complete(T val)
void	error(java.lang.Throwable exception)
T	get() Convenience method for get(0, TimeUnit.MILLISECONDS).
T	get(long timeout) Convenience method for get(timeout, TimeUnit.MILLISECONDS).
T	get(long timeout, java.util.concurrent.TimeUnit unit) Gets the results passed to this callback object.
boolean	isCancelled()
boolean	isDone() Checks whether results are already available.

Methods inherited from class java.lang.Object

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

Field Detail

exception

protected java.lang.Throwable exception

result

protected T result

hasResult

protected boolean hasResult

cancelled

protected boolean cancelled

Constructor Detail

Future

public Future()

Method Detail

complete

public void complete(T val)

error

public void error(java.lang.Throwable exception)

cancel

public boolean cancel(boolean mayInterrupt)

This method makes the waiting thread return with a CancellationException but does not cancel the actual operation the thread was waiting for.

Specified by:

cancel in interface java.util.concurrent.Future<T>

Parameters:

mayInterrupt -

Returns:

false

get

public T get()
      throws java.util.concurrent.ExecutionException

Convenience method for get(0, TimeUnit.MILLISECONDS).

Specified by:

get in interface java.util.concurrent.Future<T>

Throws:

java.util.concurrent.ExecutionException

See Also:

get(long, TimeUnit)

get

public T get(long timeout)
      throws java.util.concurrent.ExecutionException,
             java.util.concurrent.TimeoutException

Convenience method for get(timeout, TimeUnit.MILLISECONDS).

Throws:

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

See Also:

get(long, TimeUnit)

get

public T get(long timeout,
    java.util.concurrent.TimeUnit unit)
      throws java.util.concurrent.ExecutionException,
             java.util.concurrent.TimeoutException

Gets the results passed to this callback object. This method blocks until either the results are available, or the timeout is reached.

Specified by:

get in interface java.util.concurrent.Future<T>

Parameters:

timeout - number of TimeUnits to wait for results to become available

unit - TimeUnit to use

Returns:

the value resulting from the operation

Throws:

java.util.concurrent.ExecutionException - if the operation resulted in an Exception

java.util.concurrent.TimeoutException - if the timeout was reached before results were available

See Also:

get(long, TimeUnit)

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface java.util.concurrent.Future<T>

isDone

public boolean isDone()

Checks whether results are already available.

Specified by:

isDone in interface java.util.concurrent.Future<T>

Returns:

true if results have already been passed to this callback