Package com.treescrub.spedran.data

Class Series

java.lang.Object

com.treescrub.spedran.data.Resource

com.treescrub.spedran.data.IdentifiableResource

com.treescrub.spedran.data.Series

public class Series
extends IdentifiableResource

A collection of multiple games as part of one franchise.
For example: Super Mario, Sonic, Doom, Halo, and so on.
The special series named N/A is a placeholder when a game is not part of a series.

This class is immutable and thread-safe.

Constructor Summary

Constructors

Constructor	Description
Series(kong.unirest.json.JSONObject data)

Method Summary

Modifier and Type	Method	Description
String	getAbbreviation()	Gets the abbreviation for this series as used on SRC.
GameAssets	getAssets()	Gets the GameAssets for this series.
Optional<Instant>	getCreationTime()	Gets the time that this series was created on SRC.
Optional<String>	getDiscord()	Gets the Discord invite link for the Discord server dedicated to this series.
SeriesGamesRequest	getGames()	Gets a new SeriesGamesRequest builder object to request games that are part of this series.
Map<String,ModeratorType>	getModerators()	Gets a Map of user IDs as keys and moderator types as values.
Names	getNames()	Gets the Names for this series.
String	getWeblink()	Gets the link to this series on SRC.
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

Constructor Detail

Series

public Series(kong.unirest.json.JSONObject data)

Method Detail

getGames

public SeriesGamesRequest getGames()

Gets a new SeriesGamesRequest builder object to request games that are part of this series.

Returns:

a SeriesGamesRequest builder

getNames

public Names getNames()

Gets the Names for this series.

Returns:

a Names for the series name

getAbbreviation

public String getAbbreviation()

Gets the abbreviation for this series as used on SRC.

Returns:

the abbreviation

getWeblink

public String getWeblink()

Gets the link to this series on SRC.

Returns:

the link

getDiscord

public Optional<String> getDiscord()

Gets the Discord invite link for the Discord server dedicated to this series.

Returns:

an Optional with the invite link

getModerators

public Map<String,ModeratorType> getModerators()

Gets a Map of user IDs as keys and moderator types as values.

Returns:

an unmodifiable Map of user IDs to moderator types

See Also:

User, Spedran.getUser(String)

getCreationTime

public Optional<Instant> getCreationTime()

Gets the time that this series was created on SRC.

Returns:

an Optional with the Instant this series was created, empty if unknown.

getAssets

public GameAssets getAssets()

Gets the GameAssets for this series.

Returns:

a GameAssets object

toString

public String toString()

Overrides:

toString in class Object