masecla.modrinth4j.endpoints.project

Class GetProjectIdBySlug

java.lang.Object

masecla.modrinth4j.endpoints.generic.Endpoint<GetProjectIdBySlug.GetProjectIdBySlugResponse,EmptyRequest>

masecla.modrinth4j.endpoints.project.GetProjectIdBySlug

public class GetProjectIdBySlug
extends Endpoint<GetProjectIdBySlug.GetProjectIdBySlugResponse,EmptyRequest>

This endpoint is used to get a project's id by its slug.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetProjectIdBySlug.GetProjectIdBySlugResponse Represents the response from the endpoint.

Constructor Summary

Constructors

Constructor and Description
GetProjectIdBySlug(HttpClient client, com.google.gson.Gson gson) Creates a new instance of the endpoint.

Method Summary

Modifier and Type	Method and Description
String	getEndpoint() Returns the endpoint.
com.google.gson.reflect.TypeToken<EmptyRequest>	getRequestClass() Returns the request class.
com.google.gson.reflect.TypeToken<GetProjectIdBySlug.GetProjectIdBySlugResponse>	getResponseClass() Returns the response class.
boolean	requiresBody() Whether or not the endpoint requires a body.

Methods inherited from class masecla.modrinth4j.endpoints.generic.Endpoint

checkBodyForErrors, executeRequest, getMethod, getReplacedUrl, isJsonBody, readFile, readStream, sendRequest, sendRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

GetProjectIdBySlug

public GetProjectIdBySlug(HttpClient client,
                          com.google.gson.Gson gson)

Creates a new instance of the endpoint.

Parameters:

client - The client to use.

gson - The gson instance to use.

Method Detail

getEndpoint

public String getEndpoint()

Returns the endpoint.

Specified by:

getEndpoint in class Endpoint<GetProjectIdBySlug.GetProjectIdBySlugResponse,EmptyRequest>

Returns:

- The endpoint of the request.

getRequestClass

public com.google.gson.reflect.TypeToken<EmptyRequest> getRequestClass()

Returns the request class.

Specified by:

getRequestClass in class Endpoint<GetProjectIdBySlug.GetProjectIdBySlugResponse,EmptyRequest>

Returns:

- The TypeToken for the response.

getResponseClass

public com.google.gson.reflect.TypeToken<GetProjectIdBySlug.GetProjectIdBySlugResponse> getResponseClass()

Returns the response class.

Specified by:

getResponseClass in class Endpoint<GetProjectIdBySlug.GetProjectIdBySlugResponse,EmptyRequest>

Returns:

- The TypeToken for the response.

requiresBody

public boolean requiresBody()

Whether or not the endpoint requires a body.

Overrides:

requiresBody in class Endpoint<GetProjectIdBySlug.GetProjectIdBySlugResponse,EmptyRequest>

Returns:

- Whether or not the request requires a body.