Package com.treescrub.spedran

Class Spedran

java.lang.Object

com.treescrub.spedran.Spedran

public class Spedran
extends Object

The main Spedran API.

Method Summary

Modifier and Type	Method	Description
static void	clearApiKey()	Clears the current API key.
static DeleteRunRequest	deleteRun(String runId)	Gets a DeleteRunRequest builder to delete a Run.
static void	disableCache()	Disable request caching.
static void	enableCache()	Enable request caching.
static CompletableFuture<Category>	getCategory(String id)	Gets the Category that corresponds to the provided id asynchronously.
static CategoryRecordsRequest	getCategoryRecords(String categoryId)	Gets a CategoryRecordsRequest builder to request the records for the specified Category.
static CategoryVariablesRequest	getCategoryVariables(String categoryId)	Gets a CategoryVariablesRequest builder to request all the variables for the specified Category.
static CompletableFuture<Developer>	getDeveloper(String id)	Gets the Developer that corresponds to the provided id asynchronously.
static DevelopersRequest	getDevelopers()	Gets a DevelopersRequest builder to request all Developers.
static CompletableFuture<Engine>	getEngine(String id)	Gets the Engine that corresponds to the provided id asynchronously.
static EnginesRequest	getEngines()	Gets a EnginesRequest builder to request all Engines.
static CompletableFuture<Game>	getGame(String id)	Gets the Game that corresponds to the provided id asynchronously.
static GameCategoriesRequest	getGameCategories(String gameId)	Gets a GameCategoriesRequest builder to request the categories for the specified Game.
static GameLevelsRequest	getGameLevels(String gameId)	Gets a GameLevelsRequest builder to request the levels for the specified Game.
static GameRecordsRequest	getGameRecords(String gameId)	Gets a GameRecordsRequest builder to request the records for the specified Game.
static GameRomhacksRequest	getGameRomhacks(String gameId)	Gets a GameRomhacksRequest builder to request the romhacks of the specified Game.
static GamesRequest	getGames()	Gets a GamesRequest builder to request all Games matching the specified criteria.
static CompletableFuture<Gametype>	getGametype(String id)	Gets the Gametype that corresponds to the provided id asynchronously.
static GametypesRequest	getGametypes()	Gets a GametypesRequest builder to request all Gametypes.
static GameVariablesRequest	getGameVariables(String gameId)	Gets a GameVariablesRequest builder to request all the Variables of the specified Game.
static CompletableFuture<Genre>	getGenre(String id)	Gets the Genre that corresponds to the provided id asynchronously.
static GenresRequest	getGenres()	Gets a GenresRequest builder to request all Genres.
static CompletableFuture<Guest>	getGuest(String name)	Gets the Guest that corresponds to the provided name asynchronously.
static LeaderboardRequest	getLeaderboard(Game game, Category category)	Gets a LeaderboardRequest builder to request a specific Leaderboard.
static LeaderboardRequest	getLeaderboard(Game game, Category category, Level level)	Gets a LeaderboardRequest builder to request a specific Leaderboard.
static LeaderboardRequest	getLeaderboard(String gameId, String categoryId)	Gets a LeaderboardRequest builder to request a specific Leaderboard.
static LeaderboardRequest	getLeaderboard(String gameId, String categoryId, String levelId)	Gets a LeaderboardRequest builder to request a specific Leaderboard.
static CompletableFuture<Level>	getLevel(String id)	Gets the Level that corresponds to the provided id asynchronously.
static LevelCategoriesRequest	getLevelCategories(String levelId)	Gets a LevelCategoriesRequest builder to request all applicable categories for the specified Level.
static LevelRecordsRequest	getLevelRecords(String levelId)	Gets a LevelRecordsRequest builder to request the records for the specified Level.
static LevelVariablesRequest	getLevelVariables(String levelId)	Gets a LevelVariablesRequest builder to request all the variables for the specified Level.
static AllSeriesRequest	getMultipleSeries()	Gets a AllSeriesRequest builder to request all Seriess.
static CompletableFuture<List<Notification>>	getNotifications()	Gets all of the Notifications for the currently authenticated user.
static CompletableFuture<Platform>	getPlatform(String id)	Gets the Platform that corresponds to the provided id asynchronously.
static PlatformsRequest	getPlatforms()	Gets a PlatformsRequest builder to request all Platforms.
static CompletableFuture<User>	getProfile()	Gets the User that owns the current API key.
static CompletableFuture<Publisher>	getPublisher(String id)	Gets the Publisher that corresponds to the provided id asynchronously.
static PublishersRequest	getPublishers()	Gets a PublishersRequest builder to request all Publishers.
static CompletableFuture<Region>	getRegion(String id)	Gets the Region that corresponds to the provided id asynchronously.
static RegionsRequest	getRegions()	Gets a RegionsRequest builder to request all Regions.
static CompletableFuture<Run>	getRun(String id)	Gets the Run that corresponds to the provided id asynchronously.
static RunsRequest	getRuns()	Gets a RunsRequest builder to request all Runs matching the specified criteria.
static SeriesGamesRequest	getSeriesGames(String seriesId)	Gets a SeriesGamesRequest builder to request the games in the specified Series.
static CompletableFuture<Series>	getSingleSeries(String id)	Gets the Series that corresponds to the provided id asynchronously.
static CompletableFuture<User>	getUser(String id)	Gets the User that corresponds to the provided id asynchronously.
static UserPBsRequest	getUserPBs(String userId)	Gets a UserPBsRequest builder to request the personal best runs for the specified User.
static UsersRequest	getUsers()	Gets a UsersRequest builder to request all Users matching the specified criteria.
static CompletableFuture<Variable>	getVariable(String id)	Gets the Variable that corresponds to the provided id asynchronously.
static void	removeApiKey()	Identical to clearApiKey()
static void	setApiKey(String key)	Sets the current API key.
static void	setBackoffValues(double base, long reduceDelay, double constant)	Sets the values for exponential backoff.
static void	setCacheTimeLimit(long newTimeLimit)	Sets the maximum time that entries are considered valid in the request cache.
static RunPlayersRequest	setRunPlayers(String runId)	Gets a RunPlayersRequest builder to change the players in a Run.
static RunStatusRequest	setRunStatus(String runId)	Gets a RunStatusRequest builder to change the Run's verification status.
static void	shutDown()	Shuts down all work threads, allowing the application to exit.
static SubmitRunRequest	submitRun()	Gets a SubmitRunRequest builder to submit a run to SRC.

Methods inherited from class java.lang.Object

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

Method Detail

setApiKey

public static void setApiKey(String key)

Sets the current API key. The API key is not set if it is null or blank.

Parameters:

key - SRC API key

removeApiKey

public static void removeApiKey()

Identical to clearApiKey()

clearApiKey

public static void clearApiKey()

Clears the current API key.

shutDown

public static void shutDown()

Shuts down all work threads, allowing the application to exit.

enableCache

public static void enableCache()

Enable request caching.

disableCache

public static void disableCache()

Disable request caching.

setCacheTimeLimit

public static void setCacheTimeLimit(long newTimeLimit)

Sets the maximum time that entries are considered valid in the request cache.

Parameters:

newTimeLimit - the new time limit in milliseconds

setBackoffValues

public static void setBackoffValues(double base,
                                    long reduceDelay,
                                    double constant)

Sets the values for exponential backoff.
The backoff time is calculated as base^count * constant where count is the current rate limit count.

Parameters:

base - the exponent base

reduceDelay - the minimum time in milliseconds before the rate can be increased after hitting a rate limit

constant - a constant factor to multiply the backoff time by

getGame

public static CompletableFuture<Game> getGame(String id)

Gets the Game that corresponds to the provided id asynchronously.

Parameters:

id - the ID of the game to get. can be the game's abbreviation as well

Returns:

a CompletableFuture of a Game

getGameCategories

public static GameCategoriesRequest getGameCategories(String gameId)

Gets a GameCategoriesRequest builder to request the categories for the specified Game.

Parameters:

gameId - the ID of the game to get the Categorys for

Returns:

a GameCategoriesRequest builder

getGameLevels

public static GameLevelsRequest getGameLevels(String gameId)

Gets a GameLevelsRequest builder to request the levels for the specified Game.

Parameters:

gameId - the ID of the game to get the Levels for

Returns:

a GameLevelsRequest builder

getGameRecords

public static GameRecordsRequest getGameRecords(String gameId)

Gets a GameRecordsRequest builder to request the records for the specified Game.

Parameters:

gameId - the ID of the Game to get the Leaderboards for

Returns:

a GameRecordsRequest builder

getGameRomhacks

public static GameRomhacksRequest getGameRomhacks(String gameId)

Gets a GameRomhacksRequest builder to request the romhacks of the specified Game.

Parameters:

gameId - the ID of the Game to get the derived Games for

Returns:

a GameRomhacksRequest builder

getGameVariables

public static GameVariablesRequest getGameVariables(String gameId)

Gets a GameVariablesRequest builder to request all the Variables of the specified Game.

Parameters:

gameId - the ID of the Game to get the Variables for

Returns:

a GameVariablesRequest builder

getGames

public static GamesRequest getGames()

Gets a GamesRequest builder to request all Games matching the specified criteria.

Returns:

a GamesRequest builder

getRun

public static CompletableFuture<Run> getRun(String id)

Gets the Run that corresponds to the provided id asynchronously.

Parameters:

id - the ID of the run to get

Returns:

a CompletableFuture of a Run

deleteRun

public static DeleteRunRequest deleteRun(String runId)

Gets a DeleteRunRequest builder to delete a Run.

Parameters:

runId - the ID of the run to delete

Returns:

a DeleteRunRequest builder

setRunPlayers

public static RunPlayersRequest setRunPlayers(String runId)

Gets a RunPlayersRequest builder to change the players in a Run.

Parameters:

runId - the ID of the run to set the players for

Returns:

a RunPlayersRequest builder

submitRun

public static SubmitRunRequest submitRun()

Gets a SubmitRunRequest builder to submit a run to SRC.

Returns:

a SubmitRunRequest builder

setRunStatus

public static RunStatusRequest setRunStatus(String runId)

Gets a RunStatusRequest builder to change the Run's verification status.

Parameters:

runId - the ID of the run to set the status of

Returns:

a RunStatusRequest builder

getRuns

public static RunsRequest getRuns()

Gets a RunsRequest builder to request all Runs matching the specified criteria.

Returns:

a RunsRequest builder

getCategory

public static CompletableFuture<Category> getCategory(String id)

Gets the Category that corresponds to the provided id asynchronously.

Parameters:

id - the ID of the category to get

Returns:

a CompletableFuture of a Category

getCategoryRecords

public static CategoryRecordsRequest getCategoryRecords(String categoryId)

Gets a CategoryRecordsRequest builder to request the records for the specified Category.

Parameters:

categoryId - the ID of the Category to get the Leaderboards for

Returns:

a CategoryRecordsRequest builder

getCategoryVariables

public static CategoryVariablesRequest getCategoryVariables(String categoryId)

Gets a CategoryVariablesRequest builder to request all the variables for the specified Category.

Parameters:

categoryId - the ID of the Category to get the Variables for

Returns:

a CategoryVariablesRequest builder

getLevel

public static CompletableFuture<Level> getLevel(String id)

Gets the Level that corresponds to the provided id asynchronously.

Parameters:

id - the ID of the level to get

Returns:

a CompletableFuture of a Level

getLevelCategories

public static LevelCategoriesRequest getLevelCategories(String levelId)

Gets a LevelCategoriesRequest builder to request all applicable categories for the specified Level.

Parameters:

levelId - the ID of the Level to get the Categorys for

Returns:

a LevelCategoriesRequest builder

getLevelRecords

public static LevelRecordsRequest getLevelRecords(String levelId)

Gets a LevelRecordsRequest builder to request the records for the specified Level.

Parameters:

levelId - the ID of the Level to get the Leaderboards for

Returns:

a LevelRecordsRequest builder

getLevelVariables

public static LevelVariablesRequest getLevelVariables(String levelId)

Gets a LevelVariablesRequest builder to request all the variables for the specified Level.

Parameters:

levelId - the ID of the Level to get the Variables for

Returns:

a LevelVariablesRequest builder

getVariable

public static CompletableFuture<Variable> getVariable(String id)

Gets the Variable that corresponds to the provided id asynchronously.

Parameters:

id - the ID of the variable to get

Returns:

a CompletableFuture of a Variable

getProfile

public static CompletableFuture<User> getProfile()

Gets the User that owns the current API key.

Returns:

a CompletableFuture of the current authenticated User

See Also:

setApiKey(String)

getNotifications

public static CompletableFuture<List<Notification>> getNotifications()

Gets all of the Notifications for the currently authenticated user.

Returns:

a CompletableFuture with a List of notifications

See Also:

setApiKey(String)

getUser

public static CompletableFuture<User> getUser(String id)

Gets the User that corresponds to the provided id asynchronously.

Parameters:

id - the ID of the user to get

Returns:

a CompletableFuture of a User

getUsers

public static UsersRequest getUsers()

Gets a UsersRequest builder to request all Users matching the specified criteria.

Returns:

a UsersRequest builder

getUserPBs

public static UserPBsRequest getUserPBs(String userId)

Gets a UserPBsRequest builder to request the personal best runs for the specified User.

Parameters:

userId - the ID of the User to get the LeaderboardRuns for

Returns:

a UserPBsRequest builder

getGuest

public static CompletableFuture<Guest> getGuest(String name)

Gets the Guest that corresponds to the provided name asynchronously.

Parameters:

name - the name of the guest to get

Returns:

a CompletableFuture of a Guest

getGenre

public static CompletableFuture<Genre> getGenre(String id)

Gets the Genre that corresponds to the provided id asynchronously.

Parameters:

id - the ID of the genre to get

Returns:

a CompletableFuture of a Genre

getGenres

public static GenresRequest getGenres()

Gets a GenresRequest builder to request all Genres.

Returns:

a GenresRequest builder

getEngine

public static CompletableFuture<Engine> getEngine(String id)

Gets the Engine that corresponds to the provided id asynchronously.

Parameters:

id - the ID of the engine to get

Returns:

a CompletableFuture of a Engine

getEngines

public static EnginesRequest getEngines()

Gets a EnginesRequest builder to request all Engines.

Returns:

a EnginesRequest builder

getGametype

public static CompletableFuture<Gametype> getGametype(String id)

Gets the Gametype that corresponds to the provided id asynchronously.

Parameters:

id - the ID of the gametype to get

Returns:

a CompletableFuture of a Gametype

getGametypes

public static GametypesRequest getGametypes()

Gets a GametypesRequest builder to request all Gametypes.

Returns:

a GametypesRequest builder

getDeveloper

public static CompletableFuture<Developer> getDeveloper(String id)

Gets the Developer that corresponds to the provided id asynchronously.

Parameters:

id - the ID of the developer to get

Returns:

a CompletableFuture of a Developer

getDevelopers

public static DevelopersRequest getDevelopers()

Gets a DevelopersRequest builder to request all Developers.

Returns:

a DevelopersRequest builder

getRegion

public static CompletableFuture<Region> getRegion(String id)

Gets the Region that corresponds to the provided id asynchronously.

Parameters:

id - the ID of the region to get

Returns:

a CompletableFuture of a Region

getRegions

public static RegionsRequest getRegions()

Gets a RegionsRequest builder to request all Regions.

Returns:

a RegionsRequest builder

getSingleSeries

public static CompletableFuture<Series> getSingleSeries(String id)

Gets the Series that corresponds to the provided id asynchronously.

Parameters:

id - the ID of the region to get

Returns:

a CompletableFuture of a Series

getSeriesGames

public static SeriesGamesRequest getSeriesGames(String seriesId)

Gets a SeriesGamesRequest builder to request the games in the specified Series.

Parameters:

seriesId - the ID of the Series to get the Games that belong to the series

Returns:

a SeriesGamesRequest builder

getMultipleSeries

public static AllSeriesRequest getMultipleSeries()

Gets a AllSeriesRequest builder to request all Seriess.

Returns:

a AllSeriesRequest builder

getPlatform

public static CompletableFuture<Platform> getPlatform(String id)

Gets the Platform that corresponds to the provided id asynchronously.

Parameters:

id - the ID of the platform to get

Returns:

a CompletableFuture of a Platform

getPlatforms

public static PlatformsRequest getPlatforms()

Gets a PlatformsRequest builder to request all Platforms.

Returns:

a PlatformsRequest builder

getPublisher

public static CompletableFuture<Publisher> getPublisher(String id)

Gets the Publisher that corresponds to the provided id asynchronously.

Parameters:

id - the ID of the publisher to get

Returns:

a CompletableFuture of a Publisher

getPublishers

public static PublishersRequest getPublishers()

Gets a PublishersRequest builder to request all Publishers.

Returns:

a PublishersRequest builder

getLeaderboard

public static LeaderboardRequest getLeaderboard(String gameId,
                                                String categoryId,
                                                String levelId)

Gets a LeaderboardRequest builder to request a specific Leaderboard.

Parameters:

gameId - game ID to filter the leaderboard by

categoryId - category ID to filter the leaderboard by

levelId - level ID to filter the leaderboard by

Returns:

a LeaderboardRequest builder

getLeaderboard

public static LeaderboardRequest getLeaderboard(String gameId,
                                                String categoryId)

Gets a LeaderboardRequest builder to request a specific Leaderboard.

Parameters:

gameId - game ID to filter the leaderboard by

categoryId - category ID to filter the leaderboard by

Returns:

a LeaderboardRequest builder

getLeaderboard

public static LeaderboardRequest getLeaderboard(Game game,
                                                Category category,
                                                Level level)

Gets a LeaderboardRequest builder to request a specific Leaderboard.

Parameters:

game - game to filter the leaderboard by

category - category to filter the leaderboard by

level - level to filter the leaderboard by

Returns:

a LeaderboardRequest builder

getLeaderboard

public static LeaderboardRequest getLeaderboard(Game game,
                                                Category category)

Gets a LeaderboardRequest builder to request a specific Leaderboard.

Parameters:

game - game to filter the leaderboard by

category - category to filter the leaderboard by

Returns:

a LeaderboardRequest builder