com.datasift.client

Class FutureData<T>

java.lang.Object

com.datasift.client.FutureData<T>

public class FutureData<T>
extends Object

Author:

Courtney Robinson

Field Summary

Fields

Modifier and Type	Field and Description
protected BlockingQueue<Object>	block
protected T	data
protected Throwable	interruptCause
protected org.cliffc.high_scale_lib.NonBlockingHashSet<FutureResponse<T>>	listeners

Constructor Summary

Constructors

Constructor and Description
FutureData()

Method Summary

Methods

Modifier and Type	Method and Description
void	doNotify()
void	interuptCause(Throwable cause)
protected void	notifyListeners()
FutureData<T>	onData(FutureResponse<T> response) Adds an event listener that is notified when data is received
void	received(T data) Invoked when a response is received and this future data is now available for use/processing
T	sync() Forces the client to wait until a response is received before returning
static <A extends BaseDataSiftResult> FutureData<A>	wrap(A obj) Wraps any object in a FutureData instance Intended use is to enable any object obtained without a future to be passed to API methods.

Methods inherited from class java.lang.Object

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

Field Detail

listeners

protected org.cliffc.high_scale_lib.NonBlockingHashSet<FutureResponse<T>> listeners

data

protected T data

interruptCause

protected Throwable interruptCause

block

protected final BlockingQueue<Object> block

Constructor Detail

FutureData

public FutureData()

Method Detail

wrap

public static <A extends BaseDataSiftResult> FutureData<A> wrap(A obj)

Wraps any object in a FutureData instance

Intended use is to enable any object obtained without a future to be passed to API methods. This allows API methods to accept FutureData objects and alleviates the need for a user to add many callbacks and instead just pass futures around as if they were already obtained values. Note that any listeners added will be immediately invoked/notified, seeing as the result they would await has already been obtained

Type Parameters:

A - the type of the object

Parameters:

obj - the object to wrap

Returns:

a future that will fire onData events for the given object

received

public void received(T data)

Invoked when a response is received and this future data is now available for use/processing

Parameters:

data - the data received or an object wrapping said data

onData

public FutureData<T> onData(FutureResponse<T> response)

Adds an event listener that is notified when data is received

Parameters:

response - the future which should listen for a response

Returns:

this to enable chaining

notifyListeners

protected void notifyListeners()

doNotify

public void doNotify()

sync

public T sync()

Forces the client to wait until a response is received before returning

Returns:

a result instance - if an interrupt exception is thrown it is possible that a response isn't available yet the user must check to ensure null isn't returned

interuptCause

public void interuptCause(Throwable cause)