Package dev.mayuna.simpleapi

Class ApiRequestBuilder<T>

java.lang.Object

dev.mayuna.simpleapi.ApiRequestBuilder<T>

Type Parameters:

T - The type of the response.

public class ApiRequestBuilder<T>
extends java.lang.Object

A builder for ApiRequest.

Method Summary

Modifier and Type	Method	Description
ApiRequest<T>	build()	Builds the ApiRequest.
static <T> ApiRequestBuilder<T>	ofResponse(WrappedApi wrappedApi, java.lang.Class<T> responseClass)	Creates a new ApiRequestBuilder for the given WrappedApi and Class.
ApiRequestBuilder<T>	withBodyHandler(java.net.http.HttpResponse.BodyHandler<?> bodyHandler)	Sets the HttpResponse.BodyHandler of the request.
ApiRequestBuilder<T>	withBodyPublisher(java.net.http.HttpRequest.BodyPublisher bodyPublisher)	Sets the HttpRequest.BodyPublisher of the request.
ApiRequestBuilder<T>	withEndpoint(@NonNull java.lang.String endpoint)	Sets the endpoint of the request.
ApiRequestBuilder<T>	withPathParameter(@NonNull PathParameter pathParameter)	Adds a PathParameter to the request.
ApiRequestBuilder<T>	withPathParameters(@NonNull PathParameter pathParameter, PathParameter... pathParameters)	Adds multiple PathParameters to the request.
ApiRequestBuilder<T>	withRequestHeader(@NonNull RequestHeader requestHeader)	Adds a RequestHeader to the request.
ApiRequestBuilder<T>	withRequestHeaders(@NonNull RequestHeader requestHeader, RequestHeader... requestHeaders)	Adds multiple RequestHeaders to the request.
ApiRequestBuilder<T>	withRequestMethod(@NonNull RequestMethod requestMethod)	Sets the request method of the request. Pro-tip: You can use pre-defined instances of RequestMethod like RequestMethod.GET.
ApiRequestBuilder<T>	withRequestMethod(@NonNull java.lang.String requestMethod)
ApiRequestBuilder<T>	withRequestQueries(@NonNull RequestQuery requestQuery, RequestQuery... requestQueries)	Adds multiple RequestQuerys to the request.
ApiRequestBuilder<T>	withRequestQuery(@NonNull RequestQuery requestQuery)	Adds a RequestQuery to the request.
ApiRequestBuilder<T>	withUrl(@NonNull java.lang.String url)	Sets the url of the request.

Methods inherited from class java.lang.Object

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

Method Detail

ofResponse

public static <T> ApiRequestBuilder<T> ofResponse(WrappedApi wrappedApi,
                                                  java.lang.Class<T> responseClass)

Creates a new ApiRequestBuilder for the given WrappedApi and Class.

Type Parameters:

T - The type of the response.

Parameters:

wrappedApi - The WrappedApi to use.

responseClass - The Class of the response.

Returns:

The created ApiRequestBuilder.

withUrl

public ApiRequestBuilder<T> withUrl(@NonNull
                                    @NonNull java.lang.String url)

Sets the url of the request. This will override the default url of the WrappedApi.

Parameters:

url - The url to set. Should not contain a trailing slash.

Returns:

The ApiRequestBuilder instance.

withEndpoint

public ApiRequestBuilder<T> withEndpoint(@NonNull
                                         @NonNull java.lang.String endpoint)

Sets the endpoint of the request.

Parameters:

endpoint - The endpoint to set. Should contain a leading slash.

Returns:

The ApiRequestBuilder instance.

withRequestMethod

public ApiRequestBuilder<T> withRequestMethod(@NonNull
                                              @NonNull RequestMethod requestMethod)

Sets the request method of the request.
Pro-tip: You can use pre-defined instances of RequestMethod like RequestMethod.GET.

Parameters:

requestMethod - The request method to set.

Returns:

The ApiRequestBuilder instance.

withRequestMethod

public ApiRequestBuilder<T> withRequestMethod(@NonNull
                                              @NonNull java.lang.String requestMethod)

withPathParameter

public ApiRequestBuilder<T> withPathParameter(@NonNull
                                              @NonNull PathParameter pathParameter)

Adds a PathParameter to the request.

Parameters:

pathParameter - The PathParameter to add.

Returns:

The ApiRequestBuilder instance.

withPathParameters

public ApiRequestBuilder<T> withPathParameters(@NonNull
                                               @NonNull PathParameter pathParameter,
                                               PathParameter... pathParameters)

Adds multiple PathParameters to the request.

Parameters:

pathParameter - The first PathParameter to add.

pathParameters - The other PathParameters to add.

Returns:

The ApiRequestBuilder instance.

withRequestQuery

public ApiRequestBuilder<T> withRequestQuery(@NonNull
                                             @NonNull RequestQuery requestQuery)

Adds a RequestQuery to the request.

Parameters:

requestQuery - The RequestQuery to add.

Returns:

The ApiRequestBuilder instance.

withRequestQueries

public ApiRequestBuilder<T> withRequestQueries(@NonNull
                                               @NonNull RequestQuery requestQuery,
                                               RequestQuery... requestQueries)

Adds multiple RequestQuerys to the request.

Parameters:

requestQuery - The first RequestQuery to add.

requestQueries - The other RequestQuerys to add.

Returns:

The ApiRequestBuilder instance.

withRequestHeader

public ApiRequestBuilder<T> withRequestHeader(@NonNull
                                              @NonNull RequestHeader requestHeader)

Adds a RequestHeader to the request.

Parameters:

requestHeader - The RequestHeader to add.

Returns:

The ApiRequestBuilder instance.

withRequestHeaders

public ApiRequestBuilder<T> withRequestHeaders(@NonNull
                                               @NonNull RequestHeader requestHeader,
                                               RequestHeader... requestHeaders)

Adds multiple RequestHeaders to the request.

Parameters:

requestHeader - The first RequestHeader to add.

requestHeaders - The other RequestHeaders to add.

Returns:

The ApiRequestBuilder instance.

withBodyPublisher

public ApiRequestBuilder<T> withBodyPublisher(@NonNull
                                              java.net.http.HttpRequest.BodyPublisher bodyPublisher)

Sets the HttpRequest.BodyPublisher of the request.

Parameters:

bodyPublisher - The HttpRequest.BodyPublisher to set.

Returns:

The ApiRequestBuilder instance.

withBodyHandler

public ApiRequestBuilder<T> withBodyHandler(@NonNull
                                            java.net.http.HttpResponse.BodyHandler<?> bodyHandler)

Sets the HttpResponse.BodyHandler of the request.

Parameters:

bodyHandler - The HttpResponse.BodyHandler to set.

Returns:

The ApiRequestBuilder instance.

build

public ApiRequest<T> build()

Builds the ApiRequest.

Returns:

The built ApiRequest.