com.mingweisamuel.zyra.entity

Class EntityApi

java.lang.Object

com.mingweisamuel.zyra.entity.EntityApi

All Implemented Interfaces:

Closeable, AutoCloseable

public class EntityApi
extends Object
implements Closeable

API for interacting with entities. Also acts as a builder and cache for entity instances.

MatchEntities are always cached by their match ID and duplicate instances will not be created unless the previous instance has left the cache.

SummonerEntities are unambitiously cached by summoner ID or account ID, or both depending on what is supplied. Any summoners with matching IDs will not be duplicated unless the previous instance has left the cache. Summoners created using the getSummonerByName(com.mingweisamuel.zyra.enums.Region, java.lang.String) method are not put into any cache. This may change in the future.

Constructor Summary

Constructors

Constructor and Description
EntityApi(RiotApi riotApi)

Method Summary

Modifier and Type	Method and Description
void	close()
RiotApi	getApi()
MatchEntity	getMatch(Region region, long matchId) Gets a match entity by region and match ID.
MatchEntity	getMatch(Region region, long matchId, String forAccountIdEnc) Gets a match entity by region and match ID.
SummonerEntity	getSummoner(Region region, String summonerIdEnc) Gets a summoner entity by region and summoner ID.
SummonerEntity	getSummoner(Region region, String summonerIdEnc, String accountIdEnc) Gets a summoner entity by region, summoner ID, and account ID.
SummonerEntity	getSummoner(Region region, String summonerIdEnc, String accountIdEnc, String name) Gets a summoner entity by region, summoner ID, and a supplied summoner name (which will be normalized).
SummonerEntity	getSummoner(Region region, Summoner summoner) Gets a summoner entity by a Summoner instance.
SummonerEntity	getSummonerByAccountId(Region region, String accountIdEnc) Gets a summoner by region and account ID.
SummonerEntity	getSummonerByName(Region region, String name) Gets a summoner by region and a supplied summoner name (which will be normalized).
SummonerEntity	getSummonerFromPlayer(Player player) Gets a summoner entity by a Player instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityApi

public EntityApi(RiotApi riotApi)

Method Detail

getApi

public RiotApi getApi()

Returns:

The RiotApi this EntityApi uses.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getSummoner

public SummonerEntity getSummoner(Region region,
                                  String summonerIdEnc)

Gets a summoner entity by region and summoner ID. Will return a cached instance with matching summoner ID if found.

Parameters:

region - Summoner's region.

summonerIdEnc - Summoner's ID.

Returns:

A SummonerEntity instance.

getSummoner

public SummonerEntity getSummoner(Region region,
                                  String summonerIdEnc,
                                  String accountIdEnc)

Gets a summoner entity by region, summoner ID, and account ID. Will return a cached instance with matching summoner ID or account ID if found.

Summoner ID and account ID should belong to the same summoner to prevent undefined behavior. Use getSummoner(Region, String) or getSummonerByAccountId(Region, String) for whichever field is known.

Parameters:

region - Summoner's region.

summonerIdEnc - Summoner's ID.

accountIdEnc - Summoner's account ID.

Returns:

A SummonerEntity instance.

getSummoner

public SummonerEntity getSummoner(Region region,
                                  String summonerIdEnc,
                                  String accountIdEnc,
                                  String name)

Gets a summoner entity by region, summoner ID, and a supplied summoner name (which will be normalized). Will return a cached instance with matching summoner ID or account ID if found.

Summoner ID and account ID should belong to the same summoner to prevent undefined behavior. Use getSummoner(Region, String) or getSummonerByAccountId(Region, String) for whichever field is known.

Parameters:

region - Summoner's region.

summonerIdEnc - Summoner's ID.

accountIdEnc - Summoner's account ID.

name - Summoner's name. Will be normalized, so capitalization and whitespace do not matter.

Returns:

A SummonerEntity instance.

getSummoner

public SummonerEntity getSummoner(Region region,
                                  Summoner summoner)

Gets a summoner entity by a Summoner instance. Will return a cached instance with matching summoner ID or account ID if found.

Parameters:

region - Summoner's Region.

summoner - Summoner instance.

Returns:

SummonerEntity instance.

getSummonerByAccountId

public SummonerEntity getSummonerByAccountId(Region region,
                                             String accountIdEnc)

Gets a summoner by region and account ID. Will return a cached instance with matching account ID if found.

Parameters:

region - Summoner's region.

accountIdEnc - Summoner's account ID.

Returns:

A SummonerEntity instance.

getSummonerByName

public SummonerEntity getSummonerByName(Region region,
                                        String name)

Gets a summoner by region and a supplied summoner name (which will be normalized). Always returns a new instance (never caches).

Parameters:

region - Summoner's region.

name - Summoner's name.

Returns:

A SummonerEntity instance.

getSummonerFromPlayer

public SummonerEntity getSummonerFromPlayer(Player player)

Gets a summoner entity by a Player instance. Will return a cached instance with matching summoner ID or account ID if found.

Parameters:

player - Player instance from the particular summoner's game.

Returns:

SummonerEntity instance.

getMatch

public MatchEntity getMatch(Region region,
                            long matchId,
                            String forAccountIdEnc)

Gets a match entity by region and match ID. Will return a matching cached instance if found.

Parameters:

region - Match's region.

matchId - Match's ID.

forAccountIdEnc - Account ID for non-public (unranked) match participant identification.

Returns:

MatchEntity instance.

getMatch

public MatchEntity getMatch(Region region,
                            long matchId)

Gets a match entity by region and match ID. Will return a matching cached instance if found.

Parameters:

region - Match's region.

matchId - Match's ID.

Returns:

MatchEntity instance.