api.Ulti Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ulti Show documentation
Show all versions of ulti Show documentation
A Java client for the League of Legends API
/*
* 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 api;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import dto.Region;
import dto.champion.Champion;
import dto.champion.ChampionList;
import dto.game.RecentGames;
import dto.league.League;
import dto.league.QueueType;
import dto.match.MatchDetail;
import dto.matchhistory.PlayerHistory;
import dto.staticdata.champion.ChampionQueryParams;
import dto.staticdata.item.Item;
import dto.staticdata.item.ItemList;
import dto.staticdata.item.ItemQueryParams;
import dto.staticdata.mastery.Mastery;
import dto.staticdata.mastery.MasteryList;
import dto.staticdata.mastery.MasteryQueryParams;
import dto.staticdata.realm.Realm;
import dto.staticdata.rune.Rune;
import dto.staticdata.rune.RuneList;
import dto.staticdata.rune.RuneQueryParams;
import dto.staticdata.summonerspell.SummonerSpell;
import dto.staticdata.summonerspell.SummonerSpellList;
import dto.staticdata.summonerspell.SummonerSpellQueryParams;
import dto.stats.PlayerStatsSummaryList;
import dto.stats.RankedStats;
import dto.status.Shard;
import dto.status.ShardStatus;
import dto.summoner.MasteryPages;
import dto.summoner.RunePages;
import dto.summoner.Summoner;
import dto.team.Team;
import java.io.Reader;
import java.lang.reflect.Type;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import static api.QueryUtils.normalize;
import static api.QueryUtils.passLengthConstraint;
import static api.QueryUtils.prepare;
public class Ulti {
/**
* Store the latest version of each type of call, update value when new version
* is released
*/
private static final Map versions = new HashMap();
static {
versions.put("summoner", "v1.4");
versions.put("team", "v2.4");
versions.put("champion", "v1.2");
versions.put("game", "v1.3");
versions.put("league", "v2.5");
versions.put("static-data", "v1.2");
versions.put("match", "v2.2");
versions.put("matchhistory", "v2.2");
versions.put("stats", "v1.3");
versions.put("lol-status", "v1.0");
}
private final QueryManager api;
private final Gson gson;
public Ulti(String apiKey) {
api = QueryManager.getInstance();
api.setApiKey(apiKey);
gson = new Gson();
}
public Ulti(String apiKey, Region region) {
this(apiKey);
api.setRegion(region);
}
/**
* Sets the limit for the short rate
*
* @param requestsPerSecond number of requests allowed per second
*/
public void setShortRateLimit(double requestsPerSecond) {
api.setShortRateLimit(requestsPerSecond);
}
/**
* Sets the limit for the long rate.
*
* @param requestsPerSecond number of requests allowed per second
*/
public void setLongRateLimit(double requestsPerSecond) {
api.setLongRateLimit(requestsPerSecond);
}
/**
* Sets the region to be used for all requests.
*
* @param region region to use
*/
public void setRegion(Region region) {
api.setRegion(region);
}
/**
* Returns all champions currently in the game.
*
* @return championList containing a list of {@link dto.champion.Champion}.
*/
public ChampionList getChampions() {
Reader json = api.query(versions.get("champion") + "/champion");
return gson.fromJson(json, ChampionList.class);
}
/**
* Searches for a champion by their id.
*
* @param championId id of the champion
* @return a {@link dto.champion.Champion} with the specified champion id
*/
public Champion getChampionById(int championId) {
Reader json = api.query(versions.get("champion") + "/champion/" + championId);
return gson.fromJson(json, Champion.class);
}
/**
* Queries for summoners by their summoner names. A maximum of 40 summoner names can be provided.
*
* @param championNames the names of summoners to lookup
* @return a {@link java.util.Map} with keys being the summoner names as a {@link String} and values being
* a {@link dto.summoner.Summoner} object
*/
public Map getSummonerByName(String... championNames) {
if (!passLengthConstraint(championNames, 40)) {
throw new UltiException(UltiException.Type.INVALID_PARAMETERS);
}
Reader json = api.query(versions.get("summoner") + "/summoner/by-name/" + prepare(championNames));
Type type = new TypeToken>() {}.getType();
return gson.fromJson(json, type);
}
/**
* Helper function for the {@link #getSummonerByName(String...) getSummonerByName} method when only a single
* summoner name is supplied.
*
* @param summonerName the name of summoner to lookup
* @return a {@link dto.summoner.Summoner} object referring to the summoner name
*/
public Summoner getSummonerByName(String summonerName) {
return getSummonerByName(new String[]{summonerName}).get(normalize(summonerName));
}
/**
* Queries for summoners by their summoner IDs. A maximum of 40 summoner IDs can be provided.
*
* @param summonerIds the IDs of the summoners to lookup
* @return a {@link java.util.Map} with keys being the summoner IDs as a {@link String} and values being
* a {@link dto.summoner.Summoner} object
*/
public Map getSummonerById(Long... summonerIds) {
if (!passLengthConstraint(summonerIds, 40)) {
throw new UltiException(UltiException.Type.INVALID_PARAMETERS);
}
Reader json = api.query(versions.get("summoner") + "/summoner/" + prepare(summonerIds));
Type type = new TypeToken>() {}.getType();
return gson.fromJson(json, type);
}
/**
* Helper function for the {@link #getSummonerById(Long...) getSummonerById} method when only a single
* summoner ID is supplied.
*
* @param summonerId the ID of the summoner to lookup
* @return a {@link dto.summoner.Summoner} object referring to the summoner ID
*/
public Summoner getSummonerById(Long summonerId) {
return getSummonerById(new Long[]{summonerId}).get(summonerId.toString());
}
/**
* Queries for all the masteries pages of the given summoners. A maximum of 40 summoner IDs can be provided.
*
* @param summonerIds the IDs of the summoners to lookup
* @return a {@link java.util.Map} of {@link dto.summoner.MasteryPages} with summoner ID keys
* as a {@link java.lang.String}
*/
public Map getMasteriesBySummonerId(Long... summonerIds) {
if (!passLengthConstraint(summonerIds, 40)) {
throw new UltiException(UltiException.Type.INVALID_PARAMETERS);
}
Reader json = api.query(versions.get("summoner") + "/summoner/" + prepare(summonerIds) + "/masteries");
Type type = new TypeToken>() {}.getType();
return gson.fromJson(json, type);
}
/**
* Helper function for the {@link #getMasteriesBySummonerId(Long...) getMasteriesBySummonerId} method when
* only a single summoner ID is supplied.
*
* @param summonerId the ID of the summoner to lookup
* @return a {@link dto.summoner.MasteryPages} object with the masteries of the summoner
*/
public MasteryPages getMasteriesBySummonerId(Long summonerId) {
return getMasteriesBySummonerId(new Long[]{summonerId}).get(summonerId.toString());
}
/**
* Queries for a summoners name by their ID.
*
* @param summonerIds the ID of the summoner to lookup
* @return a {@link java.util.Map} of summoner names as a {@link java.lang.String} with their summoner ID
* as the key
*/
public Map getSummonerNameById(Long... summonerIds) {
Reader json = api.query(versions.get("summoner") + "/summoner/" + prepare(summonerIds) + "/name");
Type type = new TypeToken>() {}.getType();
return gson.fromJson(json, type);
}
/**
* Helper function for the {@link #getSummonerNameById(Long...) getSummonerNameById} method when only a
* single summoner ID is provided
*
* @param summonerId the ID of the summoner to lookup
* @return the summoners name as a {@link java.lang.String}
*/
public String getSummonerNameById(Long summonerId) {
return getSummonerNameById(new Long[]{summonerId}).get(summonerId.toString());
}
/**
* Queries for all the rune pages of the given summoner IDs. A maximum of 40 summoner IDs can be provided.
*
* @param ids the ID of the summoners to lookup
* @return a {@link java.util.Map} of {@link dto.summoner.RunePages} with summoner ID keys
* as a {@link java.lang.String}
*/
public Map getRunePagesBySummonerId(Long... ids) {
if (!passLengthConstraint(ids, 40)) {
throw new UltiException(UltiException.Type.INVALID_PARAMETERS);
}
Reader json = api.query(versions.get("summoner") + "/summoner/" + prepare(ids) + "/runes");
Type type = new TypeToken>() {}.getType();
return gson.fromJson(json, type);
}
/**
* Helper function for the {@link #getRunePagesBySummonerId(Long...) getRunePagesBySummonerId} method when
* only a single summoner ID is supplied.
*
* @param summonerId the ID of the summoner to lookup
* @return a {@link dto.summoner.RunePages} object with the rune pages of the summoner
*/
public RunePages getRunePagesBySummonerId(Long summonerId) {
return getRunePagesBySummonerId(new Long[]{summonerId}).get(summonerId.toString());
}
/**
* Queries for the teams of each summoner provided. A maximum of 40 summoner IDs can be provided.
*
* @param summonerIds the IDs of the summoners to lookup
* @return a {@link java.util.Map} containing a {@link java.util.List} of every {@link dto.team.Team} the
* summoner is part of, with the key being the summoner ID as a {@link String}
*/
public Map> getTeamBySummonerId(Long... summonerIds) {
if (!passLengthConstraint(summonerIds, 10)) {
throw new UltiException(UltiException.Type.INVALID_PARAMETERS);
}
Reader json = api.query(versions.get("team") + "/team/by-summoner/" + prepare(summonerIds));
Type type = new TypeToken>>() {}.getType();
return gson.fromJson(json, type);
}
/**
* Helper function for the {@link #getTeamBySummonerId(Long...) getTeamBySummonerId} method when only a
* single summoner ID is provided.
*
* @param summonerId the ID of the summoner to lookup
* @return a {@link java.util.List} of every {@link dto.team.Team} the summoner is part of.
*/
public List getTeamBySummonerId(Long summonerId) {
return getTeamBySummonerId(new Long[]{summonerId}).get(summonerId.toString());
}
/**
* Queries for the team by the teams ID. A maximum of 40 team IDs can be provided.
*
* @param teamIds the IDs of the teams to lookup
* @return a {@link java.util.Map} containing each a {@link dto.team.Team} object corresponding to each
* team ID provided.
*/
public Map getTeamById(String... teamIds) {
if (!passLengthConstraint(teamIds, 10)) {
throw new UltiException(UltiException.Type.INVALID_PARAMETERS);
}
Reader json = api.query(versions.get("team") + "/team/" + prepare(teamIds, false));
Type type = new TypeToken>() {
}.getType();
return gson.fromJson(json, type);
}
/**
* Helper function for the {@link #getTeamById(String...) getTeamById} method when only a single team
* ID is provided.
*
* @param teamId the ID of the team to lookup
* @return a {@link dto.team.Team} corresponding to the team ID.
*/
public Team getTeamById(String teamId) {
return getTeamById(new String[]{teamId}).get(teamId.toString());
}
/**
* Queries for the recent games of the summoner by their ID.
*
* @param summonerId the ID of the summoner to lookup
* @return a {@link dto.game.RecentGames} object containing the 10 most recent games of the summoner.
* @deprecated with the introduction of the MatchHistory and Match APIs, this has been deprecated and
* will be shut off at some point. Please use the provided MatchHistory and Match APIs which
* both provided a greater amount of detail.
*/
@Deprecated
public RecentGames getRecentGames(Long summonerId) {
Reader json = api.query(versions.get("game") + "/game/by-summoner/" + summonerId + "/recent");
return gson.fromJson(json, RecentGames.class);
}
/**
* Queries for the leagues of each summoner ID provided. A maximum of 10 summoner IDs can be provided.
*
* @param summonerIds the IDs of the summoners to lookup
* @return a {@link java.util.Map} containing a {@link java.util.List} of each {@link dto.league.League}
* the summoner is a part of
*/
public Map> getLeagueBySummonerId(Long... summonerIds) {
if (!passLengthConstraint(summonerIds, 10)) {
throw new UltiException(UltiException.Type.INVALID_PARAMETERS);
}
Reader json = api.query(versions.get("league") + "/league/by-summoner/" + prepare(summonerIds));
Type type = new TypeToken>>() {}.getType();
return gson.fromJson(json, type);
}
/**
* Helper function for the {@link #getLeagueBySummonerId(Long...) getLeagueBySummonerId} method when only a
* single summoner ID is provided.
*
* @param summonerId the ID of the summoner to lookup
* @return a {@link java.util.List} of each {@link dto.league.League} the summoner is a part of
*/
public List getLeagueBySummonerId(Long summonerId) {
return getLeagueBySummonerId(new Long[]{summonerId}).get(summonerId.toString());
}
/**
* Queries for the league entries of the provided summoner IDs. A maximum of 10 summoner IDs can be provided.
*
* @param summonerIds the IDs of the summoners to lookup
* @return a {@link java.util.Map} of each {@link dto.league.League} the summoner is a part of, only containing
* a {@link dto.league.LeagueEntry} for the summoner
*/
public Map> getLeagueEntryBySummonerId(Long... summonerIds) {
if (!passLengthConstraint(summonerIds, 10)) {
throw new UltiException(UltiException.Type.INVALID_PARAMETERS);
}
Reader json = api.query(versions.get("league") + "/league/by-summoner/" + prepare(summonerIds) + "/entry");
Type type = new TypeToken>>() {}.getType();
return gson.fromJson(json, type);
}
/**
* Helper function for the {@link #getLeagueEntryBySummonerId(Long...) getLeagueEntryBySummonerId} method when
* only a single summoner ID is provided.
*
* @param summonerId the ID of the summoner to lookup
* @return a {@link java.util.List} of each {@link dto.league.League} the summoner is a part of, only containing
* a {@link dto.league.LeagueEntry} for the summoner
*/
public List getLeagueEntryBySummonerId(Long summonerId) {
return getLeagueEntryBySummonerId(new Long[]{summonerId}).get(summonerId.toString());
}
/**
* Queries for leagues of each team ID provided. A maximum of 10 team IDs can be provided.
*
* @param teamIds the IDs of the teams to lookup
* @return a {@link java.util.Map} containing a {@link java.util.List} of each {@link dto.league.League}
* the team is a part of (3v3 and 5v5 leagues). The {@link dto.league.League} object contains a
* {@link dto.league.LeagueEntry} for each summoner in the respective league.
*/
public Map> getTeamLeagueById(String... teamIds) {
if (!passLengthConstraint(teamIds, 10)) {
throw new UltiException(UltiException.Type.INVALID_PARAMETERS);
}
Reader json = api.query(versions.get("league") + "/league/by-team/" + prepare(teamIds, false));
Type type = new TypeToken>>() {}.getType();
return gson.fromJson(json, type);
}
/**
* Helper function for the {@link #getTeamLeagueById(String...) getTeamLeagueById} method when only a single
* team ID is provided.
*
* @param teamId the ID of the team to lookup
* @return a {@link java.util.List} of each {@link dto.league.League} the team is a part of (3v3 and
* 5v5 leagues).
*/
public List getTeamLeagueById(String teamId) {
return getTeamLeagueById(new String[] {teamId}).get(teamId);
}
/**
* Queries for the league entries of the team IDs. A maximum of 10 team IDs can be provided.
*
* @param teamIds the IDs of the teams to lookup
* @return a {@link java.util.Map} containing a {@link java.util.List} of each {@link dto.league.League}
* the team is a part of (3v3 and 5v5 leagues). The {@link dto.league.League} object only contains
* a {@link dto.league.LeagueEntry} for the given team IDs.
*/
public Map> getTeamLeagueEntryById(String... teamIds) {
if (!passLengthConstraint(teamIds, 10)) {
throw new UltiException(UltiException.Type.INVALID_PARAMETERS);
}
Reader json = api.query(versions.get("league") + "/league/by-team/" + prepare(teamIds, false) + "/entry");
Type type = new TypeToken>>() {}.getType();
return gson.fromJson(json, type);
}
/**
* Helper function for the {@link #getTeamLeagueEntryById(String...) getTeamLeagueEntryById} method when only
* a single team ID is provided.
*
* @param teamId the ID of the team to lookup
* @return a {@link java.util.List} of each {@link dto.league.League} the team is a part of (3v3 and 5v5
* leagues). The {@link dto.league.League} object only contains a {@link dto.league.LeagueEntry}
* for the given team ID.
*/
public List getTeamLeagueEntryById(String teamId) {
return getTeamLeagueEntryById(new String[] {teamId}).get(teamId);
}
/**
* Queries for all the summoners currently in the Challenger league.
*
* @param queueType the {@link dto.league.QueueType} to query challengers from
* @return a {@link dto.league.League} object containing a {@link dto.league.LeagueEntry} for each summoner
* currently in Challenger
*/
public League getChallengers(QueueType queueType) {
Map params = new HashMap();
params.put("type", queueType.toString());
Reader json = api.query(versions.get("league") + "/league/challenger", params);
return gson.fromJson(json, League.class);
}
/**
* Queries for the ranked stats for the given summoner.
*
* @param summonerId the ID of the summoner to lookup
* @return a {@link dto.stats.RankedStats} object containing all the stats for this summoner in ranked play
*/
public RankedStats getRankedStatsBySummonerId(Long summonerId) {
Reader json = api.query(versions.get("stats") + "/stats/by-summoner/" + summonerId + "/ranked");
return gson.fromJson(json, RankedStats.class);
}
/**
* Queries for the summary of the summoners stats.
*
* @param summonerId the ID of the summoner to lookup
* @return a {@link dto.stats.PlayerStatsSummaryList} object containing a summary of all the stats for
* this summoner
*/
public PlayerStatsSummaryList getStatsSummaryBySummonerId(Long summonerId) {
Reader json = api.query(versions.get("stats") + "/stats/by-summoner/" + summonerId + "/summary");
return gson.fromJson(json, PlayerStatsSummaryList.class);
}
/**
* Queries for a match by its ID.
*
* @param matchId the ID of the match to lookup
* @return a {@link dto.match.MatchDetail} object containing detailed information for the given match
*/
public MatchDetail getMatchById(Long matchId) {
Reader json = api.query(versions.get("match") + "/match/" + matchId);
return gson.fromJson(json, MatchDetail.class);
}
/**
* Queries for the match history of the summoner.
*
* @param summonerId the ID of the summoner to lookup
* @return a {@link dto.matchhistory.PlayerHistory} object containing all of the summoners match history
*/
public PlayerHistory getMatchHistoryBySummonerId(Long summonerId) {
Reader json = api.query(versions.get("matchhistory") + "/matchhistory/" + summonerId);
return gson.fromJson(json, PlayerHistory.class);
}
/**
* Queries for the status of all LOL servers.
*
* @return a {@link java.util.List} of {@link dto.status.Shard} objects reflecting the server status
*/
public List getServerStatus() {
Reader json = api.statusQuery("shards");
Type type = new TypeToken>() {}.getType();
return gson.fromJson(json, type);
}
/**
* Queries for the status of a server status for the given {@code region}.
*
* @param region region to query status for
* @return a {@link dto.status.ShardStatus} object representing the server status for the {@code region}
*/
public ShardStatus getServerStatus(Region region) {
Reader json = api.statusQuery("shards/" + region);
return gson.fromJson(json, ShardStatus.class);
}
/**
* Queries the static api for a list of champions in the game.
*
* Requests to this API will not be counted in your Rate Limit.
*
* @return a {@link dto.staticdata.champion.ChampionList}
*/
public dto.staticdata.champion.ChampionList getStaticChampionList() {
return getStaticChampionList(null);
}
/**
* Queries the static api for a list of champions in the game.
*
* @param championQueryParams champion query parameters
* @return a {@link dto.champion.ChampionList}
*
* @see dto.staticdata.champion.ChampData
* @see dto.staticdata.champion.ChampionQueryParams
*/
public dto.staticdata.champion.ChampionList getStaticChampionList(ChampionQueryParams championQueryParams) {
Reader json = api.staticQuery(versions.get("static-data") + "/champion",
championQueryParams != null ? championQueryParams.getParams() : null);
return gson.fromJson(json, dto.staticdata.champion.ChampionList.class);
}
/**
* Queries the static api for a specific champion in the game by {@code championId}
*
* Requests to this API will not be counted in your Rate Limit.
*
* @param championId the id of the champion to query
* @return a {@link dto.staticdata.champion.Champion} representing the champion
*/
public dto.staticdata.champion.Champion getStaticChampion(int championId) {
return getStaticChampion(championId, null);
}
/**
* Queries the static api for a specific champion in the game by {@code championId}
*
* @param championId the id of the champion to query
* @param championQueryParams query parameters
* @return a {@link dto.staticdata.champion.Champion} representing the champion
*
* @see dto.staticdata.champion.ChampData
* @see dto.staticdata.champion.ChampionQueryParams
*/
public dto.staticdata.champion.Champion getStaticChampion(int championId, ChampionQueryParams championQueryParams) {
Reader json = api.staticQuery(versions.get("static-data") + "/champion/" + championId,
championQueryParams != null ? championQueryParams.getParams() : null);
return gson.fromJson(json, dto.staticdata.champion.Champion.class);
}
/**
* Queries the static api for a list of all the items in the game.
*
* Requests to this API will not be counted in your Rate Limit.
*
* @return an {@link dto.staticdata.item.ItemList}
*/
public ItemList getStaticItemList() {
return getStaticItemList(null);
}
/**
* Queries the static api for a list of all the items in the game.
*
* Requests to this API will not be counted in your Rate Limit.
*
* @param itemQueryParams item query parameters
* @return an {@link dto.staticdata.item.ItemList}
*
* @see dto.staticdata.item.ItemListData
* @see dto.staticdata.item.ItemQueryParams
*/
public ItemList getStaticItemList(ItemQueryParams itemQueryParams) {
Reader json = api.staticQuery(versions.get("static-data") + "/item",
itemQueryParams != null ? itemQueryParams.getParams() : null);
return gson.fromJson(json, ItemList.class);
}
/**
* Queries the static api for a specific item in the game by {@code itemId}
*
* Requests to this API will not be counted in your Rate Limit.
*
* @param itemId id of the item to query
* @return an {@link dto.staticdata.item.Item} representing the item
*/
public Item getStaticItem(int itemId) {
return getStaticItem(itemId, null);
}
/**
* Queries the static api for a specific item in the game by {@code itemId}
*
* Requests to this API will not be counted in your Rate Limit.
*
* @param itemId id of the item to query
* @param itemQueryParams item query parameters
* @return an {@link dto.staticdata.item.Item} representing the item
*
* @see dto.staticdata.item.ItemListData
* @see dto.staticdata.item.ItemQueryParams
*/
public Item getStaticItem(int itemId, ItemQueryParams itemQueryParams) {
Reader json = api.staticQuery(versions.get("static-data") + "/item/" + itemId,
itemQueryParams != null ? itemQueryParams.getParams() : null);
return gson.fromJson(json, Item.class);
}
/**
* Queries the static api for a list of all the masteries in the game.
*
* Requests to this API will not be counted in your Rate Limit.
*
* @return a {@link dto.staticdata.mastery.MasteryList}
*/
public MasteryList getStaticMasteryList() {
return getStaticMasteryList(null);
}
/**
* Queries the static api for a list of all the masteries in the game.
*
* Requests to this API will not be counted in your Rate Limit.
*
* @param masteryQueryParams mastery query parameters
* @return a {@link dto.staticdata.mastery.MasteryList}
*
* @see dto.staticdata.mastery.MasteryListData
* @see dto.staticdata.mastery.MasteryQueryParams
*/
public MasteryList getStaticMasteryList(MasteryQueryParams masteryQueryParams) {
Reader json = api.staticQuery(versions.get("static-data") + "/mastery",
masteryQueryParams != null ? masteryQueryParams.getParams() : null);
return gson.fromJson(json, MasteryList.class);
}
/**
* Queries the static api for a specific mastery in the game by {@code masteryId}
*
* Requests to this API will not be counted in your Rate Limit.
*
* @param masteryId id of the mastery to query
* @return a {@link dto.staticdata.mastery.Mastery} representing the mastery
*/
public Mastery getStaticMastery(int masteryId) {
return getStaticMastery(masteryId, null);
}
/**
* Queries the static api for a specific mastery in the game by {@code masteryId}
*
* Requests to this API will not be counted in your Rate Limit.
*
* @param masteryId id of the mastery to query
* @param masteryQueryParams mastery query parameters
* @return a {@link dto.staticdata.mastery.Mastery} representing the mastery
*
* @see dto.staticdata.mastery.MasteryListData
* @see dto.staticdata.mastery.MasteryQueryParams
*/
public Mastery getStaticMastery(int masteryId, MasteryQueryParams masteryQueryParams) {
Reader json = api.staticQuery(versions.get("static-data") + "/mastery/" + masteryId,
masteryQueryParams != null ? masteryQueryParams.getParams() : null);
return gson.fromJson(json, Mastery.class);
}
/**
* Queries the static api for realm information
*
* Requests to this API will not be counted in your Rate Limit.
*
* @return a {@link dto.staticdata.realm.Realm} object representing the details of the realm
*/
public Realm getStaticRealm() {
Reader json = api.staticQuery(versions.get("static-data") + "/realm");
return gson.fromJson(json, Realm.class);
}
/**
* Queries the static api for a list of all the runes in the game.
*
* Requests to this API will not be counted in your Rate Limit.
*
* @return a {@link dto.staticdata.rune.RuneList}
*/
public RuneList getStaticRuneList() {
return getStaticRuneList(null);
}
/**
* Queries the static api for a list of all the runes in the game.
*
* Requests to this API will not be counted in your Rate Limit.
*
* @param runeQueryParams rune query parameters
* @return a {@link dto.staticdata.rune.RuneList}
*
* @see dto.staticdata.rune.RuneListData
* @see dto.staticdata.rune.RuneQueryParams
*/
public RuneList getStaticRuneList(RuneQueryParams runeQueryParams) {
Reader json = api.staticQuery(versions.get("static-data") + "/rune",
runeQueryParams != null ? runeQueryParams.getParams() : null);
return gson.fromJson(json, RuneList.class);
}
/**
* Queries the static api for a specific rune in the game by {@code runeId}
*
* Requests to this API will not be counted in your Rate Limit.
*
* @param runeId id of the rune to query
* @return a {@link dto.staticdata.rune.Rune} representing the rune
*/
public Rune getStaticRune(int runeId) {
return getStaticRune(runeId, null);
}
/**
* Queries the static api for a specific rune in the game by {@code runeId}
*
* Requests to this API will not be counted in your Rate Limit.
*
* @param runeId id of the rune to query
* @param runeQueryParams rune query parameters
* @return a {@link dto.staticdata.rune.Rune} representing the rune
*
* @see dto.staticdata.rune.RuneListData
* @see dto.staticdata.rune.RuneQueryParams
*/
public Rune getStaticRune(int runeId, RuneQueryParams runeQueryParams) {
Reader json = api.staticQuery(versions.get("static-data") + "/rune/" + runeId,
runeQueryParams != null ? runeQueryParams.getParams() : null);
return gson.fromJson(json, Rune.class);
}
/**
* Queries the static api for a list of all the summoner spells in the game.
*
* Requests to this API will not be counted in your Rate Limit.
*
* @return a {@link dto.staticdata.summonerspell.SummonerSpellList}
*/
public SummonerSpellList getStaticSummonerSpellList() {
return getStaticSummonerSpellList(null);
}
/**
* Queries the static api for a list of all the summoner spells in the game.
*
* Requests to this API will not be counted in your Rate Limit.
*
* @param summonerSpellQueryParams summoner spell query parameters
* @return a {@link dto.staticdata.summonerspell.SummonerSpellList}
*
* @see dto.staticdata.summonerspell.SpellData
* @see dto.staticdata.summonerspell.SummonerSpellQueryParams
*/
public SummonerSpellList getStaticSummonerSpellList(SummonerSpellQueryParams summonerSpellQueryParams) {
Reader json = api.staticQuery(versions.get("static-data") + "/summoner-spell",
summonerSpellQueryParams != null ? summonerSpellQueryParams.getParams() : null);
return gson.fromJson(json, SummonerSpellList.class);
}
/**
* Queries the static api for a specific summoner spell in the game by {@code summonerSpellId}
*
* Requests to this API will not be counted in your Rate Limit.
*
* @param summonerSpellId id of the summoner spell to query
* @return a {@link dto.staticdata.summonerspell.SummonerSpell} representing the summoner spell
*/
public SummonerSpell getStaticSummonerSpell(int summonerSpellId) {
return getStaticSummonerSpell(summonerSpellId, null);
}
/**
* Queries the static api for a specific summoner spell in the game by {@code summonerSpellId}
*
* Requests to this API will not be counted in your Rate Limit.
*
* @param summonerSpellId id of the summoner spell to query
* @param summonerSpellQueryParams summoner spell query parameters
* @return a {@link dto.staticdata.summonerspell.SummonerSpell} representing the summoner spell
*
* @see dto.staticdata.summonerspell.SpellData
* @see dto.staticdata.summonerspell.SummonerSpellQueryParams
*/
public SummonerSpell getStaticSummonerSpell(int summonerSpellId, SummonerSpellQueryParams summonerSpellQueryParams) {
Reader json = api.staticQuery(versions.get("static-data") + "/summoner-spell/" + summonerSpellId,
summonerSpellQueryParams != null ? summonerSpellQueryParams.getParams() : null);
return gson.fromJson(json, SummonerSpell.class);
}
/**
* Queries the static api for all versions of the data
*
* @return a {@link java.util.List} of {@link java.lang.String} containing each version of the static data backend
*/
public List getStaticVersions() {
Reader json = api.staticQuery(versions.get("static-data") + "/versions");
Type type = new TypeToken>() {}.getType();
return gson.fromJson(json, type);
}
}