org.djodjo.comm.jus.request

Class RequestFuture<T>

java.lang.Object

org.djodjo.comm.jus.request.RequestFuture<T>

Type Parameters:

T - The type of parsed response this future expects.

All Implemented Interfaces:

java.util.concurrent.Future<T>, Response.ErrorListener, Response.Listener<T>

public class RequestFuture<T>
extends java.lang.Object
implements java.util.concurrent.Future<T>, Response.Listener<T>, Response.ErrorListener

A Future that represents a Jus request. Used by providing as your response and error listeners. For example:

 RequestFuture<JSONObject> future = RequestFuture.newFuture();
 MyRequest request = new MyRequest(URL, future, future);

 // If you want to be able to cancel the request:
 future.setRequest(requestQueue.add(request));

 // Otherwise:
 requestQueue.add(request);

 try {
   JSONObject response = future.get();
   // do something with response
 } catch (InterruptedException e) {
   // handle the error
 } catch (ExecutionException e) {
   // handle the error
 }
 

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning)
T	get()
T	get(long timeout, java.util.concurrent.TimeUnit unit)
boolean	isCancelled()
boolean	isDone()
static <E> RequestFuture<E>	newFuture()
void	onErrorResponse(JusError error) Callback method that an error has been occurred with the provided error code and optional user-readable message.
void	onResponse(T response) Called when a response is received.
void	setRequest(Request<?> request)

Methods inherited from class java.lang.Object

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

Method Detail

newFuture

public static <E> RequestFuture<E> newFuture()

setRequest

public void setRequest(Request<?> request)

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

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

get

public T get()
      throws java.lang.InterruptedException,
             java.util.concurrent.ExecutionException

Specified by:

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

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

get

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

Specified by:

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

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

isCancelled

public boolean isCancelled()

Specified by:

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

isDone

public boolean isDone()

Specified by:

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

onResponse

public void onResponse(T response)

Description copied from interface: Response.Listener

Called when a response is received.

Specified by:

onResponse in interface Response.Listener<T>

onErrorResponse

public void onErrorResponse(JusError error)

Description copied from interface: Response.ErrorListener

Callback method that an error has been occurred with the provided error code and optional user-readable message.

Specified by:

onErrorResponse in interface Response.ErrorListener