com.ibasco.agql.core

Class AbstractWebApiInterface<C extends AbstractRestClient,R extends AbstractWebApiRequest,S extends AbstractWebApiResponse<com.google.gson.JsonElement>>

java.lang.Object

com.ibasco.agql.core.AbstractWebApiInterface<C,R,S>

Type Parameters:

C - Any class extending AbstractRestClient

R - Any class extending AbstractWebRequest

Direct Known Subclasses:

CocWebApiInterface, CsgoWebApiInterface, Dota2WebApiInterface, SteamStorefront, SteamWebApiInterface

public abstract class AbstractWebApiInterface<C extends AbstractRestClient,R extends AbstractWebApiRequest,S extends AbstractWebApiResponse<com.google.gson.JsonElement>>
extends Object

An API Interface containing a set/group of methods that are usually defined by the publisher

Author:

Rafael Luis Ibasco

Field Summary

Fields

Modifier and Type	Field and Description
static int	VERSION_1 Used by the underlying concrete classes for api versioning
static int	VERSION_2 Used by the underlying concrete classes for api versioning
static int	VERSION_3 Used by the underlying concrete classes for api versioning

Constructor Summary

Constructors

Constructor and Description
AbstractWebApiInterface(C client) Default Constructor

Method Summary

Modifier and Type	Method and Description
protected <A extends Collection> A	asCollectionOf(Class itemType, String searchKey, com.google.gson.JsonObject searchElement, Class<? extends Collection> collectionClass, boolean strict) A Utility function that retrieves the specified json element and converts it to a Parameterized Collection instance.
protected <A> List<A>	asListOf(Class itemType, String searchKey, com.google.gson.JsonObject searchElement, boolean strict) Similar to asCollectionOf(Class, String, JsonObject, Class, boolean) minus the Collection class argument.
protected com.google.gson.Gson	builder() Lazy-Inititalization
protected void	configureBuilder(com.google.gson.GsonBuilder builder) Override this method if you need to perform additional configurations against the builder (e.g.
protected <V> V	fromJson(com.google.gson.JsonElement element, Class<V> classTypeOf) fromJson.
protected <V> V	fromJson(com.google.gson.JsonElement element, Type typeOf) fromJson.
protected void	handleError(AbstractWebResponse response, Throwable error) The default error handler.
protected <A> CompletableFuture<A>	sendRequest(R request) Sends a requests to the internal client.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_1

public static final int VERSION_1

Used by the underlying concrete classes for api versioning

See Also:

Constant Field Values

VERSION_2

public static final int VERSION_2

Used by the underlying concrete classes for api versioning

See Also:

Constant Field Values

VERSION_3

public static final int VERSION_3

Used by the underlying concrete classes for api versioning

See Also:

Constant Field Values

Constructor Detail

AbstractWebApiInterface

public AbstractWebApiInterface(C client)

Default Constructor

Parameters:

client - A AbstractRestClient instance

Method Detail

fromJson

protected <V> V fromJson(com.google.gson.JsonElement element,
                         Class<V> classTypeOf)

fromJson.

Type Parameters:

V - a V class

Parameters:

element - a JsonElement object

classTypeOf - a Class object

Returns:

a V object

builder

protected com.google.gson.Gson builder()

Lazy-Inititalization

Returns:

A Gson instance

configureBuilder

protected void configureBuilder(com.google.gson.GsonBuilder builder)

Override this method if you need to perform additional configurations against the builder (e.g. Register custom deserializers)

Parameters:

builder - A GsonBuilder instance that will be accessed and configured by a concrete AbstractWebApiInterface implementation

asListOf

protected <A> List<A> asListOf(Class itemType,
                               String searchKey,
                               com.google.gson.JsonObject searchElement,
                               boolean strict)

Similar to asCollectionOf(Class, String, JsonObject, Class, boolean) minus the Collection class argument. This also returns a List collection type instead.

Type Parameters:

A - The type of the List to be returned

Parameters:

itemType - The Class type of the item in the Collection

searchKey - The name of the JsonArray element that we will convert

searchElement - The JsonObject that will be used to search for the JsonArray element

strict - If true an exception will be thrown if the listName is not found within the search element specified. Otherwise no exceptions will be raised and an empty Collection instance will be returned.

Returns:

A List containing the parsed json entities

asCollectionOf

protected <A extends Collection> A asCollectionOf(Class itemType,
                                                  String searchKey,
                                                  com.google.gson.JsonObject searchElement,
                                                  Class<? extends Collection> collectionClass,
                                                  boolean strict)

A Utility function that retrieves the specified json element and converts it to a Parameterized Collection instance.

Type Parameters:

A - The internal type of the Collection to be returned

Parameters:

itemType - The Class type of the item in the Collection

searchKey - The name of the JsonArray element that we will convert

searchElement - The JsonObject that will be used to search for the JsonArray element

collectionClass - A Class representing the concrete implementation of the Collection

strict - If true an exception will be thrown if the listName is not found within the search element specified. Otherwise no exceptions will be raised and an empty Collection instance will be returned.

Returns:

A Collection containing the type specified by collectionClass argument

fromJson

protected <V> V fromJson(com.google.gson.JsonElement element,
                         Type typeOf)

fromJson.

Type Parameters:

V - a V class

Parameters:

element - a JsonElement object

typeOf - a Type object

Returns:

a V object

sendRequest

protected <A> CompletableFuture<A> sendRequest(R request)

Sends a requests to the internal client.

Type Parameters:

A - a A class

Parameters:

request - An instance of AbstractWebRequest

Returns:

A CompletableFuture that will hold the expected value once a response has been received by the server

handleError

protected void handleError(AbstractWebResponse response,
                           Throwable error)

The default error handler. Override this if needed.

Parameters:

response - An instance of AbstractWebApiResponse or null if an exception was thrown.

error - A Throwable instance or null if no error has occured.