com.mingweisamuel.zyra.entity

Class SummonerEntity

java.lang.Object

com.mingweisamuel.zyra.entity.Entity

com.mingweisamuel.zyra.entity.SummonerEntity

public class SummonerEntity
extends Entity

A high-level representation of a Summoner. Thread-safe.

Field Summary

Fields inherited from class com.mingweisamuel.zyra.entity.Entity

entityApi, region

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other) Checks that this SummonerEntity is from the same region and has the same summoner ID as OTHER.
CompletableFuture<String>	getAccountIdAsync()
String	getAccountIdEnc()
List<ChampionMastery>	getChampionMasteries()
CompletableFuture<List<ChampionMastery>>	getChampionMasteriesAsync()
CurrentGameInfo	getCurrentGameInfo()
CompletableFuture<CurrentGameInfo>	getCurrentGameInfoAsync()
List<LeaguePosition>	getLeaguePositions()
CompletableFuture<List<LeaguePosition>>	getLeaguePositionsAsync()
Matchlist	getMatchQuery() Queries matches with the parameters set by setMatchQuery*** methods.
CompletableFuture<Matchlist>	getMatchQueryAsync() Queries matches with the parameters set by setMatchQuery*** methods.
List<MatchEntity>	getMatchQueryEntities() Queries matches with the parameters set by setMatchQuery*** methods.
CompletableFuture<List<MatchEntity>>	getMatchQueryEntitiesAsync() Queries matches with the parameters set by setMatchQuery*** methods.
String	getStandardizedName()
CompletableFuture<String>	getStandardizedNameAsync()
CompletableFuture<String>	getSummonerIdAsync()
String	getSummonerIdEnc()
Summoner	getSummonerInfo()
CompletableFuture<Summoner>	getSummonerInfoAsync()
int	hashCode() Returns a hashed-sized version of this SummonerEntitiy's summoner ID with the summoner region.
boolean	isMatchQueryDirty() Checks if the query is dirty.
boolean	loadedAccountId()
boolean	loadedChampionMasteries()
boolean	loadedCurrentGameInfo()
boolean	loadedLeaguePositions()
boolean	loadedMatchQuery()
boolean	loadedSummonerId()
boolean	loadedSummonerInfo()
void	resetChampionMasteries()
void	resetCurrentGameInfo()
void	resetLeaguePositions()
void	resetMatchQuery() Removes all query restrictions and marks the match query dirty.
void	resetSummonerInfo()
boolean	setMatchQueryAll(List<Integer> queues, Long beginTime, Long endTime, List<Integer> champions, List<Integer> seasons, Integer beginIndex, Integer endIndex) Method for setting all query parameters at once.
boolean	setMatchQueryChampions(List<Integer> champions) Sets the champions for a match query.
boolean	setMatchQueryIndexRange(Integer beginIndex, Integer endIndex) Sets the begin and end indices for a match query.
boolean	setMatchQueryQueues(List<Integer> queues) Sets the queues parameter for a match query.
boolean	setMatchQuerySeasons(List<Integer> seasons) Sets the seasons for a match query.
boolean	setMatchQueryTimeRange(Long beginTime, Long endTime) Sets the begin and end time for a match query.

Methods inherited from class com.mingweisamuel.zyra.entity.Entity

getRegion

Methods inherited from class java.lang.Object

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

Method Detail

loadedSummonerId

public boolean loadedSummonerId()

getSummonerIdAsync

public CompletableFuture<String> getSummonerIdAsync()

getSummonerIdEnc

public String getSummonerIdEnc()

loadedAccountId

public boolean loadedAccountId()

getAccountIdAsync

public CompletableFuture<String> getAccountIdAsync()

getAccountIdEnc

public String getAccountIdEnc()

getStandardizedNameAsync

public CompletableFuture<String> getStandardizedNameAsync()

getStandardizedName

public String getStandardizedName()

loadedSummonerInfo

public boolean loadedSummonerInfo()

getSummonerInfoAsync

public CompletableFuture<Summoner> getSummonerInfoAsync()

getSummonerInfo

public Summoner getSummonerInfo()

resetSummonerInfo

public void resetSummonerInfo()

loadedChampionMasteries

public boolean loadedChampionMasteries()

getChampionMasteriesAsync

public CompletableFuture<List<ChampionMastery>> getChampionMasteriesAsync()

getChampionMasteries

public List<ChampionMastery> getChampionMasteries()

resetChampionMasteries

public void resetChampionMasteries()

loadedLeaguePositions

public boolean loadedLeaguePositions()

getLeaguePositionsAsync

public CompletableFuture<List<LeaguePosition>> getLeaguePositionsAsync()

getLeaguePositions

public List<LeaguePosition> getLeaguePositions()

resetLeaguePositions

public void resetLeaguePositions()

loadedCurrentGameInfo

public boolean loadedCurrentGameInfo()

getCurrentGameInfoAsync

public CompletableFuture<CurrentGameInfo> getCurrentGameInfoAsync()

getCurrentGameInfo

public CurrentGameInfo getCurrentGameInfo()

resetCurrentGameInfo

public void resetCurrentGameInfo()

isMatchQueryDirty

public boolean isMatchQueryDirty()

Checks if the query is dirty. Returning true means that the match query parameters have been updated and a new request must be sent to obtain the matchlists. False means that a call to getMatchQuery() or getMatchQueryEntities() will return immediately.

Returns:

Whether the query is dirty.

resetMatchQuery

public void resetMatchQuery()

Removes all query restrictions and marks the match query dirty.

setMatchQueryAll

public boolean setMatchQueryAll(List<Integer> queues,
                                Long beginTime,
                                Long endTime,
                                List<Integer> champions,
                                List<Integer> seasons,
                                Integer beginIndex,
                                Integer endIndex)

Method for setting all query parameters at once.

Parameters:

queues -

beginTime -

endTime -

champions -

seasons -

beginIndex -

endIndex -

Returns:

Whether the query is dirty.

setMatchQueryQueues

public boolean setMatchQueryQueues(List<Integer> queues)

Sets the queues parameter for a match query.

Parameters:

queues - Queue encId list, or null to remove.

Returns:

Whether the query is dirty.

setMatchQueryTimeRange

public boolean setMatchQueryTimeRange(Long beginTime,
                                      Long endTime)

Sets the begin and end time for a match query. Both bounds are inclusive.
setMatchQueryTimeRange(null, null) will remove the time restriction.

Parameters:

beginTime - Begin time in epoch milliseconds, or null to remove.

endTime - End time in epoch milliseconds, or null to remove.

Returns:

Whether the query is dirty.

Throws:

IllegalArgumentException - If beginTime is greater than endTime.

setMatchQueryChampions

public boolean setMatchQueryChampions(List<Integer> champions)

Sets the champions for a match query.

Parameters:

champions - Champions that summoner played in queried matches, or null to remove.

Returns:

Whether the query is dirty.

setMatchQuerySeasons

public boolean setMatchQuerySeasons(List<Integer> seasons)

Sets the seasons for a match query.

Parameters:

seasons - Seasons to return matches from.

Returns:

Whether the query is dirty.

setMatchQueryIndexRange

public boolean setMatchQueryIndexRange(Integer beginIndex,
                                       Integer endIndex)

Sets the begin and end indices for a match query. Range bounds are inclusive (probably).
setMatchQueryIndexRange(null, null) will remove the index restriction.

Parameters:

beginIndex - Begin index, or null to remove.

endIndex - End index, or null to remove.

Returns:

Whether the query is dirty.

Throws:

IllegalArgumentException - If beginIndex is greater than endIndex.

loadedMatchQuery

public boolean loadedMatchQuery()

Returns:

Whether the match query is not dirty and has been loaded.

getMatchQueryAsync

public CompletableFuture<Matchlist> getMatchQueryAsync()

Queries matches with the parameters set by setMatchQuery*** methods. Only sends a new request if the query is marked dirty (parameters have been updated).

Returns:

A CompletableFuture of the Matchlist.

getMatchQuery

public Matchlist getMatchQuery()

Queries matches with the parameters set by setMatchQuery*** methods. Only sends a new request if the query is marked dirty (parameters have been updated).

Returns:

The Matchlist.

getMatchQueryEntitiesAsync

public CompletableFuture<List<MatchEntity>> getMatchQueryEntitiesAsync()

Queries matches with the parameters set by setMatchQuery*** methods. Only sends a new request if the query is marked dirty (parameters have been updated).

May returned cached instances as described in EntityApi.getMatch(com.mingweisamuel.zyra.enums.Region, long, java.lang.String).

Returns:

A CompletableFuture of the List of MatchEntities.

getMatchQueryEntities

public List<MatchEntity> getMatchQueryEntities()

Queries matches with the parameters set by setMatchQuery*** methods. Only sends a new request if the query is marked dirty (parameters have been updated).

May returned cached instances as described in EntityApi.getMatch(com.mingweisamuel.zyra.enums.Region, long, java.lang.String).

Returns:

The List of MatchEntities.

equals

public boolean equals(Object other)

Checks that this SummonerEntity is from the same region and has the same summoner ID as OTHER. Will load the summoner IDs if needed.

Overrides:

equals in class Object

Parameters:

other - Object to compare to.

Returns:

True if equal.

hashCode

public int hashCode()

Returns a hashed-sized version of this SummonerEntitiy's summoner ID with the summoner region. Will load the summoner ID if needed.

Overrides:

hashCode in class Object

Returns:

Summoner ID hash.