Package se.michaelthelin.spotify.requests

Class AbstractRequest.Builder<T,BT extends AbstractRequest.Builder<T,?>>

java.lang.Object

se.michaelthelin.spotify.requests.AbstractRequest.Builder<T,BT>

Type Parameters:

T - The response type.

BT - The builder type.

All Implemented Interfaces:

IRequest.Builder<T,BT>

Direct Known Subclasses:

AbstractAuthorizationRequest.Builder, AbstractDataRequest.Builder, AuthorizationCodePKCERefreshRequest.Builder, AuthorizationCodePKCERequest.Builder, AuthorizationCodeUriRequest.Builder

Enclosing class:

AbstractRequest<T>

public abstract static class AbstractRequest.Builder<T,BT extends AbstractRequest.Builder<T,?>>
extends Object
implements IRequest.Builder<T,BT>

Abstract builder class for requests.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Protected constructor for request builders.

Method Summary

Modifier and Type	Method	Description
protected abstract BT	self()	Return this instance to simulate a self-type.
BT	setBody(org.apache.hc.core5.http.HttpEntity httpEntity)	Set the body for the request.
<X> BT	setBodyParameter(String name, X value)	Set a body parameter for the request.
BT	setContentType(org.apache.hc.core5.http.ContentType contentType)	Set the content type for the request.
BT	setDefaults(IHttpManager httpManager, String scheme, String host, Integer port)	Set default values for the request.
<X> BT	setHeader(String name, X value)	Set a header for the request.
BT	setHost(String host)	Set the host for the request.
BT	setHttpManager(IHttpManager httpManager)	Set the HTTP manager for the request.
BT	setPath(String path)	Set the path for the request.
BT	setPathParameter(String name, String value)	Set a path parameter for the request.
BT	setPort(Integer port)	Set the port for the request.
<X> BT	setQueryParameter(String name, X value)	Set a query parameter for the request.
BT	setScheme(String scheme)	Set the scheme for the request.

Methods inherited from class java.lang.Object

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

Methods inherited from interface se.michaelthelin.spotify.requests.IRequest.Builder

build

Constructor Details

Builder

protected Builder()

Protected constructor for request builders.

Method Details

setHttpManager

public BT setHttpManager(IHttpManager httpManager)

Description copied from interface: IRequest.Builder

Set the HTTP manager for the request.

Specified by:

setHttpManager in interface IRequest.Builder<T,BT extends AbstractRequest.Builder<T,?>>

Parameters:

httpManager - The HTTP manager.

Returns:

This builder instance.

setScheme

public BT setScheme(String scheme)

Description copied from interface: IRequest.Builder

Set the scheme for the request.

Specified by:

setScheme in interface IRequest.Builder<T,BT extends AbstractRequest.Builder<T,?>>

Parameters:

scheme - The scheme.

Returns:

This builder instance.

setHost

public BT setHost(String host)

Description copied from interface: IRequest.Builder

Set the host for the request.

Specified by:

setHost in interface IRequest.Builder<T,BT extends AbstractRequest.Builder<T,?>>

Parameters:

host - The host.

Returns:

This builder instance.

setPort

public BT setPort(Integer port)

Description copied from interface: IRequest.Builder

Set the port for the request.

Specified by:

setPort in interface IRequest.Builder<T,BT extends AbstractRequest.Builder<T,?>>

Parameters:

port - The port.

Returns:

This builder instance.

setPath

public BT setPath(String path)

Description copied from interface: IRequest.Builder

Set the path for the request.

Specified by:

setPath in interface IRequest.Builder<T,BT extends AbstractRequest.Builder<T,?>>

Parameters:

path - The path.

Returns:

This builder instance.

setPathParameter

public BT setPathParameter(String name,
 String value)

Description copied from interface: IRequest.Builder

Set a path parameter for the request.

Specified by:

setPathParameter in interface IRequest.Builder<T,BT extends AbstractRequest.Builder<T,?>>

Parameters:

name - The parameter name.

value - The parameter value.

Returns:

This builder instance.

setDefaults

public BT setDefaults(IHttpManager httpManager,
 String scheme,
 String host,
 Integer port)

Description copied from interface: IRequest.Builder

Set default values for the request.

Specified by:

setDefaults in interface IRequest.Builder<T,BT extends AbstractRequest.Builder<T,?>>

Parameters:

httpManager - The HTTP manager.

scheme - The scheme.

host - The host.

port - The port.

Returns:

This builder instance.

setQueryParameter

public <X> BT setQueryParameter(String name,
 X value)

Description copied from interface: IRequest.Builder

Set a query parameter for the request.

Specified by:

setQueryParameter in interface IRequest.Builder<T,BT extends AbstractRequest.Builder<T,?>>

Type Parameters:

X - The parameter value type.

Parameters:

name - The parameter name.

value - The parameter value.

Returns:

This builder instance.

setHeader

public <X> BT setHeader(String name,
 X value)

Description copied from interface: IRequest.Builder

Set a header for the request.

Specified by:

setHeader in interface IRequest.Builder<T,BT extends AbstractRequest.Builder<T,?>>

Type Parameters:

X - The header value type.

Parameters:

name - The header name.

value - The header value.

Returns:

This builder instance.

setContentType

public BT setContentType(org.apache.hc.core5.http.ContentType contentType)

Description copied from interface: IRequest.Builder

Set the content type for the request.

Specified by:

setContentType in interface IRequest.Builder<T,BT extends AbstractRequest.Builder<T,?>>

Parameters:

contentType - The content type.

Returns:

This builder instance.

setBody

public BT setBody(org.apache.hc.core5.http.HttpEntity httpEntity)

Description copied from interface: IRequest.Builder

Set the body for the request.

Specified by:

setBody in interface IRequest.Builder<T,BT extends AbstractRequest.Builder<T,?>>

Parameters:

httpEntity - The HTTP entity body.

Returns:

This builder instance.

setBodyParameter

public <X> BT setBodyParameter(String name,
 X value)

Description copied from interface: IRequest.Builder

Set a body parameter for the request.

Specified by:

setBodyParameter in interface IRequest.Builder<T,BT extends AbstractRequest.Builder<T,?>>

Type Parameters:

X - The parameter value type.

Parameters:

name - The parameter name.

value - The parameter value.

Returns:

This builder instance.

self

protected abstract BT self()

Return this instance to simulate a self-type.

Returns:

This instance.