com.syncthemall.diffbot.api

Class Future<T>

java.lang.Object

com.syncthemall.diffbot.api.Future<T>

Type Parameters:

T - the type of Diffbot API result, either Article or Frontpage

All Implemented Interfaces:

Serializable

public class Future<T>
extends Object
implements Serializable

Wrapper used with the Diffbot batch API. Represents a future response from Diffbot. A Future contains :

• A Request used to call the Diffbot API and obtain a result
• A callback reference to the DiffbotAPI that created this Future. It is used to trigger the batch API call.
• A T result representing the result of the call corresponding to the Request.
• A DiffbotException if the call resulted in an error. If an DiffbotException exist it will be thrown when trying to access the result.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Future(Request request, DiffbotAPI callback) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
T	get() If a batch request containing the Request of this Future has already been executed, return the result obtained.
protected Request	getRequest()
protected Future<T>	setError(DiffbotException error)
protected Future<T>	setExecuted(boolean executed)
protected Future<T>	setResult(T result)

Methods inherited from class java.lang.Object

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

Constructor Detail

Future

protected Future(Request request,
      DiffbotAPI callback)

Default constructor.

Parameters:

request - Request used to call the Diffbot API and obtain a result

callback - a reference to the DiffbotAPI that created this Future

Method Detail

getRequest

protected final Request getRequest()

setResult

protected final Future<T> setResult(T result)

setExecuted

protected final Future<T> setExecuted(boolean executed)

setError

protected final Future<T> setError(DiffbotException error)

get

public final T get()
            throws DiffbotAPIException,
                   DiffbotIOException,
                   DiffbotUnauthorizedException,
                   DiffbotServerException,
                   DiffbotParseException

If a batch request containing the Request of this Future has already been executed, return the result obtained. If not, executes the batch request and returns the result for the Request of this Future.

Returns:

the Article or Frontpage obtained for this Future

Throws:

DiffbotAPIException

DiffbotIOException

DiffbotParseException

DiffbotUnauthorizedException - if the developer token is not recognized or revoked

DiffbotServerException - if a HTTP error occurs on the Diffbot server

DiffbotIOException - if an IO error (usually network related) occur during the API call

DiffbotAPIException - if an API error occur on Diffbot servers while processing the request