Class BetterStatsRestAPI

java.lang.Object

com.thecsdev.betterstats.resource.dto.BetterStatsRestAPI

@Internal
public final class BetterStatsRestAPI
extends Object

This class represents TheCSDev's REST-ful APIs specifically designed for this mod. The API provides various endpoints that allow the mod to fetch and interact with additional features and data beyond the standard statistics screen functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	BetterStatsRestAPI.RateLimitingInfo	Provides telemetry information used by the REST-ful API.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object obj)
static final CompletableFuture<BetterStatsRestAPI>	fetchAsync()	Fetches the REST API data from the endpoint specified in this mod's configuration.
static final CompletableFuture<BetterStatsRestAPI>	fetchAsync(@NotNull URI apiEndpoint)	Fetches the REST API data from the specified endpoint.
static final CompletableFuture<List<CreditsSection>>	fetchBuiltInCreditsAsync()	Fetches the built-in "Credits" data from the classpath resource.
final CompletableFuture<List<CreditsSection>>	fetchCreditsAsync()	Fetches the "Credits" data from this RESTful API.
static final CompletableFuture<List<CreditsSection>>	fetchCreditsAsync(@NotNull URI creditsUri)	Fetches the "Credits" data from the specified URI.
final CompletableFuture<List<CreditsSection>>	fetchNewsAsync()	Fetches the "News" data from this RESTful API.
final @NotNull URI	getCreditsURI()	Returns the URI of the "Credits" endpoint in this RESTful API.
final @NotNull URI	getEndpointURI()	Returns the URI of the RESTful API endpoint used to fetch this BetterStatsRestAPI.
final @NotNull URI	getNewsURI()	Returns the URI of the "News" endpoint in this RESTful API.
final int	hashCode()

Methods inherited from class Object

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

Method Details

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

getEndpointURI

@NotNull
public final @NotNull URI getEndpointURI()

Returns the URI of the RESTful API endpoint used to fetch this BetterStatsRestAPI.

getCreditsURI

@NotNull
public final @NotNull URI getCreditsURI()

Returns the URI of the "Credits" endpoint in this RESTful API.

getNewsURI

@NotNull
public final @NotNull URI getNewsURI()

Returns the URI of the "News" endpoint in this RESTful API.

fetchCreditsAsync

public final CompletableFuture<List<CreditsSection>> fetchCreditsAsync()

Fetches the "Credits" data from this RESTful API.

Returns:

A CompletableFuture that will complete with the fetched CreditsSection instances.

fetchNewsAsync

public final CompletableFuture<List<CreditsSection>> fetchNewsAsync()

Fetches the "News" data from this RESTful API.

Returns:

A CompletableFuture that will complete with the fetched CreditsSection CreditsSection instances.

fetchBuiltInCreditsAsync

public static final CompletableFuture<List<CreditsSection>> fetchBuiltInCreditsAsync()

Fetches the built-in "Credits" data from the classpath resource.

Returns:

A CompletableFuture that will complete with the fetched CreditsSection instances.

fetchCreditsAsync

public static final CompletableFuture<List<CreditsSection>> fetchCreditsAsync(@NotNull
 @NotNull URI creditsUri)

Fetches the "Credits" data from the specified URI.

Parameters:

creditsUri - The URI to fetch the "Credits" data from.

Returns:

A CompletableFuture that will complete with the fetched CreditsSection instances.

Throws:

NullPointerException - If the argument is null.

fetchAsync

public static final CompletableFuture<BetterStatsRestAPI> fetchAsync()

Fetches the REST API data from the endpoint specified in this mod's configuration.

Returns:

A CompletableFuture that will complete with the fetched BetterStatsRestAPI instance.

fetchAsync

@Internal
public static final CompletableFuture<BetterStatsRestAPI> fetchAsync(@NotNull
 @NotNull URI apiEndpoint)
                                                              throws NullPointerException

Fetches the REST API data from the specified endpoint.

Parameters:

apiEndpoint - The endpoint URI to fetch the REST API data from.

Returns:

A CompletableFuture that will complete with the fetched BetterStatsRestAPI instance.

Throws:

NullPointerException - If the argument is null.