masecla.modrinth4j.endpoints

Class SearchEndpoint

java.lang.Object

masecla.modrinth4j.endpoints.generic.Endpoint<O,I>

masecla.modrinth4j.endpoints.generic.PaginatedEndpoint<SearchEndpoint.SearchResult,SearchEndpoint.SearchResponse,SearchEndpoint.SearchRequest>

masecla.modrinth4j.endpoints.SearchEndpoint

public class SearchEndpoint
extends PaginatedEndpoint<SearchEndpoint.SearchResult,SearchEndpoint.SearchResponse,SearchEndpoint.SearchRequest>

Represents the search endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchEndpoint.IndexType The IndexType to sort the results by.
static class	SearchEndpoint.SearchRequest Represents a search request.
static class	SearchEndpoint.SearchResponse Represents a search response.
static class	SearchEndpoint.SearchResult Represents a search result.

Nested classes/interfaces inherited from class masecla.modrinth4j.endpoints.generic.PaginatedEndpoint

PaginatedEndpoint.PaginatedRequest, PaginatedEndpoint.PaginatedResponse<T>

Constructor Summary

Constructors

Constructor and Description
SearchEndpoint(HttpClient client, com.google.gson.Gson gson) Creates a new search endpoint.

Method Summary

Modifier and Type	Method and Description
String	getEndpoint() Returns the endpoint to use.
com.google.gson.reflect.TypeToken<SearchEndpoint.SearchRequest>	getRequestClass() Returns the request class to use.
com.google.gson.reflect.TypeToken<SearchEndpoint.SearchResponse>	getResponseClass() Returns the response class to use.
boolean	isJsonBody() If this endpoint uses a JSON body.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchEndpoint

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

Creates a new search endpoint.

Parameters:

client - - The client to use

gson - - The gson instance to use

Method Detail

getEndpoint

public String getEndpoint()

Returns the endpoint to use.

Specified by:

getEndpoint in class Endpoint<SearchEndpoint.SearchResponse,SearchEndpoint.SearchRequest>

Returns:

- The endpoint of the request.

getRequestClass

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

Returns the request class to use.

Specified by:

getRequestClass in class Endpoint<SearchEndpoint.SearchResponse,SearchEndpoint.SearchRequest>

Returns:

- The TypeToken of the request.

getResponseClass

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

Returns the response class to use.

Specified by:

getResponseClass in class Endpoint<SearchEndpoint.SearchResponse,SearchEndpoint.SearchRequest>

Returns:

- The TypeToken of the response.

isJsonBody

public boolean isJsonBody()

If this endpoint uses a JSON body.

Overrides:

isJsonBody in class Endpoint<SearchEndpoint.SearchResponse,SearchEndpoint.SearchRequest>

Returns:

- Whether or not the request body should be JSON.