com.mingweisamuel.zyra.entity

Class MatchEntity

java.lang.Object

com.mingweisamuel.zyra.entity.Entity

com.mingweisamuel.zyra.entity.MatchEntity

public class MatchEntity
extends Entity

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MatchEntity.ParticipantEntity A entity representation of a participantInfo in a single match.
class	MatchEntity.TeamEntity An entity representation of a team in a single match.

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) Returns true if this MatchEntity has the same match ID and is from the same region as OTHER.
String	getForAccountIdEnc() Returns the account ID supplied at construction, used for non-public (unranked) match participant identification.
Match	getInfo()
CompletableFuture<Match>	getInfoAsync()
long	getMatchId() Returns the unique match encId.
MatchEntity.ParticipantEntity	getParticipant(SummonerEntity summonerEntity) Gets the Participant corresponding to the given SummonerEntity.
CompletableFuture<MatchEntity.ParticipantEntity>	getParticipantAsync(SummonerEntity summonerEntity) Gets a CompletableFuture of the Participant corresponding to the given SummonerEntity.
List<MatchEntity.ParticipantEntity>	getParticipants()
CompletableFuture<List<MatchEntity.ParticipantEntity>>	getParticipantsAsync()
List<MatchEntity.TeamEntity>	getTeams()
CompletableFuture<List<MatchEntity.TeamEntity>>	getTeamsAsync()
MatchTimeline	getTimeline()
CompletableFuture<MatchTimeline>	getTimelineAsync()
int	hashCode()

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

getMatchId

public long getMatchId()

Returns the unique match encId. Does not need to wait for any tasks to complete.

getForAccountIdEnc

public String getForAccountIdEnc()

Returns the account ID supplied at construction, used for non-public (unranked) match participant identification.

Returns:

NULL if no account ID was originally supplied.

getInfoAsync

public CompletableFuture<Match> getInfoAsync()

getInfo

public Match getInfo()

getTimelineAsync

public CompletableFuture<MatchTimeline> getTimelineAsync()

getTimeline

public MatchTimeline getTimeline()

getParticipantsAsync

public CompletableFuture<List<MatchEntity.ParticipantEntity>> getParticipantsAsync()

getParticipants

public List<MatchEntity.ParticipantEntity> getParticipants()

getParticipantAsync

public CompletableFuture<MatchEntity.ParticipantEntity> getParticipantAsync(SummonerEntity summonerEntity)

Gets a CompletableFuture of the Participant corresponding to the given SummonerEntity. Will return null if the summoner was not found. This may occur in unranked games where identity information is not available.

Parameters:

summonerEntity - Summoner to find.

Returns:

CompletableFuture of ParticipantEntity, or of null if not found.

getParticipant

public MatchEntity.ParticipantEntity getParticipant(SummonerEntity summonerEntity)

Gets the Participant corresponding to the given SummonerEntity. Will return null if the summoner was not found. This usually occurs in unranked games where identity information is not available and forAccountIdEnc was not provided..

Parameters:

summonerEntity - Summoner to find.

Returns:

ParticipantEntity, or null if not found.

getTeamsAsync

public CompletableFuture<List<MatchEntity.TeamEntity>> getTeamsAsync()

getTeams

public List<MatchEntity.TeamEntity> getTeams()

equals

public boolean equals(Object other)

Returns true if this MatchEntity has the same match ID and is from the same region as OTHER.

Overrides:

equals in class Object

Parameters:

other - Object to compare to.

Returns:

True if equal.

hashCode

public int hashCode()

Overrides:

hashCode in class Object