Package com.treescrub.spedran.data

Class Run

java.lang.Object

com.treescrub.spedran.data.Resource

com.treescrub.spedran.data.IdentifiableResource

com.treescrub.spedran.data.Run

public class Run
extends IdentifiableResource

A speedrun on SRC.

This class is immutable and thread-safe.

Method Summary

Modifier and Type	Method	Description
DeleteRunRequest	delete()	Gets a new DeleteRunRequest builder to delete this run from SRC.
String	getCategory()	Returns a String containing the ID of this run's category.
Optional<String>	getComment()	Gets the description of this run.
Optional<LocalDate>	getDateRan()	Returns the LocalDate that this run was actually ran.
String	getGame()	Returns a String containing the ID of this run's game.
Optional<String>	getLevel()	Returns an Optional String containing the ID of this run's level.
List<RunPlayer>	getPlayers()	Gets a List of the runners of this run.
RunTimes	getRunTimes()	Gets the times for this run in each timing category.
Optional<Link>	getSplits()	Gets a link to the API of a splits hosting site.
RunStatus	getStatus()	Gets the current verification status of this run.
Optional<Instant>	getSubmitTime()	Returns the Instant that this run was submitted to SRC.
RunSystem	getSystem()	Gets the system that this run was played on.
Map<String,String>	getVariableValues()	Returns a Map with each key being a variable ID, and the corresponding value being the variable value ID.
Optional<RunVideos>	getVideos()	Gets a RunVideos describing the videos in this run.
String	getWeblink()	Returns a String containing the URL of the run on SRC.
RunPlayersRequest	setPlayers()	Gets a new RunPlayersRequest builder to set the players on this run.
RunStatusRequest	setStatus()	Gets a new RunStatusRequest builder to change the status of this run.
String	toString()

Methods inherited from class com.treescrub.spedran.data.IdentifiableResource

equals, getId, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

delete

public DeleteRunRequest delete()

Gets a new DeleteRunRequest builder to delete this run from SRC.
Requires a set API key with sufficient permissions to delete runs, or API key of run owner.

Returns:

a DeleteRunRequest builder

See Also:

Spedran.setApiKey(String)

setPlayers

public RunPlayersRequest setPlayers()

Gets a new RunPlayersRequest builder to set the players on this run.
Requires a set API key with sufficient permissions to change the players on this run.

Returns:

a RunPlayersRequest builder

setStatus

public RunStatusRequest setStatus()

Gets a new RunStatusRequest builder to change the status of this run.
Requires an API key with sufficient permissions to reject/verify runs.

Returns:

a request builder to set the status

getWeblink

public String getWeblink()

Returns a String containing the URL of the run on SRC.

Returns:

a link to the run

getGame

public String getGame()

Returns a String containing the ID of this run's game.

Returns:

the id of the game this run belongs to

See Also:

Game, Spedran.getGame(String)

getLevel

public Optional<String> getLevel()

Returns an Optional String containing the ID of this run's level. If this run has no associated level, returns an empty Optional.

Returns:

an Optional with the ID of this run's level

See Also:

Level, Spedran.getLevel(String)

getCategory

public String getCategory()

Returns a String containing the ID of this run's category.

Returns:

the ID of this run's category

See Also:

Category, Spedran.getCategory(String)

getVideos

public Optional<RunVideos> getVideos()

Gets a RunVideos describing the videos in this run.

Returns:

an Optional with information about this run's videos

getComment

public Optional<String> getComment()

Gets the description of this run.

Returns:

an Optional with the run comment

getStatus

public RunStatus getStatus()

Gets the current verification status of this run.

Returns:

a RunStatus with verification info

getPlayers

public List<RunPlayer> getPlayers()

Gets a List of the runners of this run.

Returns:

an unmodifiable List of the runners

getDateRan

public Optional<LocalDate> getDateRan()

Returns the LocalDate that this run was actually ran.

Returns:

a LocalDate

getSubmitTime

public Optional<Instant> getSubmitTime()

Returns the Instant that this run was submitted to SRC.

Returns:

a Instant

getRunTimes

public RunTimes getRunTimes()

Gets the times for this run in each timing category.

Returns:

a RunTimes object that has timing info

getSystem

public RunSystem getSystem()

Gets the system that this run was played on.

Returns:

a RunSystem object that has system info

getSplits

public Optional<Link> getSplits()

Gets a link to the API of a splits hosting site. Currently only supports Splits.io.

Returns:

an Optional with a Link that contains info about splits

getVariableValues

public Map<String,String> getVariableValues()

Returns a Map with each key being a variable ID, and the corresponding value being the variable value ID.

Returns:

an unmodifiable Map between variable IDs and variable value IDs

toString

public String toString()

Overrides:

toString in class Object