org.dc.riot.lol.rx.service.interfaces

Class ApiFactory

java.lang.Object

org.dc.riot.lol.rx.service.interfaces.ApiFactory

public final class ApiFactory
extends java.lang.Object

Use this class to generate instances of RiotApi interfaces. Use the associated ApiFactory.Builder to call into specific versions if needed. newDefaultFactory(ApiKey) is the easiest way to get ApiFactory and RiotApi instances.

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApiFactory.Builder Used to create ApiFactory instances pointed at specific versions.

Method Summary

Modifier and Type	Method and Description
static com.google.gson.Gson	getGson()
RiotApi.Champion	newChampionInterface(Region region, boolean autoRateControl)
RiotApi.ChampionMastery	newChampionMasteryInterface(Region region, boolean autoRateControl)
RiotApi.CurrentGame	newCurrentGameInterface(Region region, boolean autoRateControl)
static ApiFactory	newDefaultFactory(ApiKey apiKey) Basic entry point to fetching Riot's LoL API data.
RiotApi.FeaturedGames	newFeaturedGamesInterface(Region region, boolean autoRateControl)
RiotApi.League	newLeagueInterface(Region region, boolean autoRateControl)
RiotApi.Match	newMatchInterface(Region region, boolean autoRateControl)
RiotApi.MatchList	newMatchListInterface(Region region, boolean autoRateControl)
RiotApi.RecentGames	newRecentGamesInterface(Region region, boolean autoRateControl)
RiotApi.StaticData	newStaticDataInterface(Region region, boolean autoRateControl)
RiotApi.Stats	newStatsInterface(Region region, boolean autoRateControl)
RiotApi.LolStatus	newStatusInterface(Region region, boolean autoRateControl)
RiotApi.Summoner	newSummonerInterface(Region region, boolean autoRateControl)
RiotApi.Team	newTeamInterface(Region region, boolean autoRateControl)

Methods inherited from class java.lang.Object

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

Method Detail

getGson

public static com.google.gson.Gson getGson()

Returns:

the Gson to be used for all deserializations. This is a custom built Gson instance, new instances of Gson may not properly deserialize responses.

newDefaultFactory

public static ApiFactory newDefaultFactory(ApiKey apiKey)

Basic entry point to fetching Riot's LoL API data. This method creates a factory that will return interface calls for all recent versions of the LoL API.

Parameters:

apiKey - API key that this factory will use to create interface connections

Returns:

a ApiFactory for the given API key to access all newest LoL API versions

newChampionInterface

public RiotApi.Champion newChampionInterface(Region region,
                                             boolean autoRateControl)

newChampionMasteryInterface

public RiotApi.ChampionMastery newChampionMasteryInterface(Region region,
                                                           boolean autoRateControl)

newCurrentGameInterface

public RiotApi.CurrentGame newCurrentGameInterface(Region region,
                                                   boolean autoRateControl)

newFeaturedGamesInterface

public RiotApi.FeaturedGames newFeaturedGamesInterface(Region region,
                                                       boolean autoRateControl)

newRecentGamesInterface

public RiotApi.RecentGames newRecentGamesInterface(Region region,
                                                   boolean autoRateControl)

newLeagueInterface

public RiotApi.League newLeagueInterface(Region region,
                                         boolean autoRateControl)

newStaticDataInterface

public RiotApi.StaticData newStaticDataInterface(Region region,
                                                 boolean autoRateControl)

newStatsInterface

public RiotApi.Stats newStatsInterface(Region region,
                                       boolean autoRateControl)

newStatusInterface

public RiotApi.LolStatus newStatusInterface(Region region,
                                            boolean autoRateControl)

newMatchInterface

public RiotApi.Match newMatchInterface(Region region,
                                       boolean autoRateControl)

newMatchListInterface

public RiotApi.MatchList newMatchListInterface(Region region,
                                               boolean autoRateControl)

newSummonerInterface

public RiotApi.Summoner newSummonerInterface(Region region,
                                             boolean autoRateControl)

newTeamInterface

public RiotApi.Team newTeamInterface(Region region,
                                     boolean autoRateControl)