com.ibasco.agql.protocols.valve.dota2.webapi

Class Dota2WebApiInterface

java.lang.Object

com.ibasco.agql.core.AbstractWebApiInterface<SteamWebApiClient,Dota2WebApiRequest,Dota2WebApiResponse>

com.ibasco.agql.protocols.valve.dota2.webapi.Dota2WebApiInterface

Direct Known Subclasses:

Dota2Econ, Dota2Fantasy, Dota2Match, Dota2Stats, Dota2Stream, Dota2Teams

public abstract class Dota2WebApiInterface
extends AbstractWebApiInterface<SteamWebApiClient,Dota2WebApiRequest,Dota2WebApiResponse>

Abstract Dota2WebApiInterface class.

Author:

Rafael Luis Ibasco

Field Summary

Fields inherited from class com.ibasco.agql.core.AbstractWebApiInterface

VERSION_1, VERSION_2, VERSION_3

Constructor Summary

Constructors

Constructor and Description
Dota2WebApiInterface(SteamWebApiClient client) Constructor for Dota2WebApiInterface.

Method Summary

Modifier and Type	Method and Description
protected <T> List<T>	asCollectionOf(Class type, String listName, com.google.gson.JsonObject root) asCollectionOf.
protected <T> List<T>	asListOf(Class type, String listName, com.google.gson.JsonObject root, boolean strict) Similar to AbstractWebApiInterface.asCollectionOf(Class, String, JsonObject, Class, boolean) minus the Collection class argument.
protected com.google.gson.JsonObject	getValidResult(com.google.gson.JsonObject json) getValidResult.

Methods inherited from class com.ibasco.agql.core.AbstractWebApiInterface

asCollectionOf, builder, configureBuilder, fromJson, fromJson, handleError, sendRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

Dota2WebApiInterface

public Dota2WebApiInterface(SteamWebApiClient client)

Constructor for Dota2WebApiInterface.

Parameters:

client - a SteamWebApiClient object

Method Detail

asCollectionOf

protected <T> List<T> asCollectionOf(Class type,
                                     String listName,
                                     com.google.gson.JsonObject root)

asCollectionOf.

Type Parameters:

T - a T class

Parameters:

type - a Class object

listName - a String object

root - a JsonObject object

Returns:

a List object

asListOf

protected <T> List<T> asListOf(Class type,
                               String listName,
                               com.google.gson.JsonObject root,
                               boolean strict)

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

Overrides:

asListOf in class AbstractWebApiInterface<SteamWebApiClient,Dota2WebApiRequest,Dota2WebApiResponse>

Type Parameters:

T - The type of the List to be returned

Parameters:

type - The Class type of the item in the Collection

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

root - 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

getValidResult

protected com.google.gson.JsonObject getValidResult(com.google.gson.JsonObject json)

getValidResult.

Parameters:

json - a JsonObject object

Returns:

a JsonObject object