masecla.modrinth4j.endpoints.project

Class GetProject

java.lang.Object

masecla.modrinth4j.endpoints.generic.Endpoint<Project,EmptyRequest>

masecla.modrinth4j.endpoints.project.GetProject

public class GetProject
extends Endpoint<Project,EmptyRequest>

This endpoint is used to get a project.

Constructor Summary

Constructors

Constructor and Description
GetProject(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<Project>	getResponseClass() Returns the response class.
boolean	requiresBody() Returns whether 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

GetProject

public GetProject(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<Project,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<Project,EmptyRequest>

Returns:

- The TypeToken for the response.

getResponseClass

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

Returns the response class.

Specified by:

getResponseClass in class Endpoint<Project,EmptyRequest>

Returns:

- The TypeToken for the response.

requiresBody

public boolean requiresBody()

Returns whether the endpoint requires a body.

Overrides:

requiresBody in class Endpoint<Project,EmptyRequest>

Returns:

- Whether or not the request requires a body.