com.ibasco.agql.protocols.valve.dota2.webapi.Dota2WebApiInterface Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of agql-dota2-webapi Show documentation
Implementation for the Dota 2 Web API Interfaces
There is a newer version: 1.2.2
/*
 * Copyright (c) 2022 Asynchronous Game Query Library
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

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

import com.google.gson.JsonArray;
import com.google.gson.JsonObject;
import com.ibasco.agql.core.AbstractWebApiInterface;
import com.ibasco.agql.core.reflect.types.CollectionParameterizedType;
import com.ibasco.agql.protocols.valve.dota2.webapi.exceptions.Dota2WebException;
import com.ibasco.agql.protocols.valve.steam.webapi.SteamWebApiClient;
import java.util.ArrayList;
import java.util.List;

/**
 * Abstract Dota2WebApiInterface class.
 *
 * @author Rafael Luis Ibasco
 */
abstract public class Dota2WebApiInterface extends AbstractWebApiInterface {

    /**
     * Constructor for Dota2WebApiInterface.
     *
     * @param client
     *         a {@link com.ibasco.agql.protocols.valve.steam.webapi.SteamWebApiClient} object
     */
    public Dota2WebApiInterface(SteamWebApiClient client) {
        super(client);
    }

    /**
     * asCollectionOf.
     *
     * @param type
     *         a {@link java.lang.Class} object
     * @param listName
     *         a {@link java.lang.String} object
     * @param root
     *         a {@link com.google.gson.JsonObject} object
     * @param 
     *         a T class
     *
     * @return a {@link java.util.List} object
     */
    protected  List asCollectionOf(Class type, String listName, JsonObject root) {
        return asListOf(type, listName, root, false);
    }

    /** {@inheritDoc} */
    @SuppressWarnings("all")
    protected  List asListOf(Class type, String listName, JsonObject root, boolean strict) {
        //Process json
        JsonArray items = null;
        try {
            items = getValidResult(root).getAsJsonArray(listName);
        } catch (Dota2WebException e) {
            //if we didn't find a result container, check the top level
            if (root.has(listName) && root.get(listName).isJsonArray())
                items = root.getAsJsonArray(listName);
        }
        if (items == null) {
            if (strict)
                throw new Dota2WebException(String.format("Unable to find '%s' from the response", listName));
            else
                return new ArrayList<>();
        }
        //Parse then return the Parameterized List
        return fromJson(items, new CollectionParameterizedType(type, ArrayList.class));
    }

    /**
     * getValidResult.
     *
     * @param json
     *         a {@link com.google.gson.JsonObject} object
     *
     * @return a {@link com.google.gson.JsonObject} object
     */
    protected JsonObject getValidResult(JsonObject json) {
        JsonObject result = json.getAsJsonObject("result");
        if (result != null)
            return result;
        throw new Dota2WebException(String.format("The response either did not contain the desired result or the server responded in error. (JSON = %s)", json));
    }
}