dto.staticdata.champion.ChampionQueryParams Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ulti Show documentation
A Java client for the League of Legends API
There is a newer version: 1.2.0
/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2014 Adam Alyyan
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 * and associated documentation files (the "Software"), to deal in the Software without restriction,
 *  including without limitation the rights to use, copy, modify, merge, publish, distribute,
 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
 * is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or
 * substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package dto.staticdata.champion;

import api.QueryParams;
import com.google.common.base.Joiner;

import java.util.HashMap;
import java.util.Map;

/**
 * Helper class for passing in parameters when querying champion data via the static API
 */
public class ChampionQueryParams implements QueryParams {

    private String locale;
    private String version;
    private boolean dataById;
    private ChampData[] champData;

    private ChampionQueryParams(Builder builder) {
        this.locale = builder.locale;
        this.version = builder.version;
        this.dataById = builder.dataById;
        this.champData = builder.champData;
    }

    @Override
    public Map getParams() {
        Map map = new HashMap();
        if (locale != null) map.put("locale", locale);
        if (version != null) map.put("version", version);
        if (dataById) map.put("dataById", Boolean.toString(dataById));
        if (champData != null) map.put("champData", Joiner.on(",").join(champData));

        return map;
    }

    public static class Builder {
        private String locale;
        private String version;
        private boolean dataById;
        private ChampData[] champData;

        /**
         * @param  locale Locale code for returned data (e.g., en_US, es_ES). If not specified, the default
         *         locale for the region is used.
         */
        public Builder locale(String locale) {
            this.locale = locale;
            return this;
        }

        /**
         * @param   version Data dragon version for returned data. If not specified, the latest version for the region
         *          is used. List of valid versions can be obtained from the /versions endpoint
         *
         * @see     api.Ulti#getStaticVersions()
         */
        public Builder version(String version) {
            this.version = version;
            return this;
        }

        /**
         * @param   dataById If specified as true, the returned data map will use the champions' IDs as the keys.
         *                   If not specified or specified as false, the returned data map will use the champions'
         *                   keys instead.
         */
        public Builder dataById(boolean dataById) {
            this.dataById = dataById;
            return this;
        }

        /**
         * @param   champData Tags to return additional data. Only type, version, data, id, key, name, and title are
         *                    returned by default if this parameter isn't specified. To return all additional data,
         *                    use the tag 'all'.
         *
         * @see     dto.staticdata.champion.ChampData
         */
        public Builder champData(ChampData... champData) {
            this.champData = champData;
            return this;
        }

        public ChampionQueryParams build() {
            return new ChampionQueryParams(this);
        }
    }
}