Interface QueryParameterBasedRequest

All Known Subinterfaces:

GetEpisodeBasedRequest, GetMovieBasedRequest, GetSeasonBasedRequest, GetSeriesBasedRequest

All Known Implementing Classes:

GetByIdRequestBase, GetByTitleRequestBase, GetEpisodeByIdRequest, GetEpisodeByTitleRequest, GetMovieByIdRequest, GetMovieByTitleRequest, GetSeasonByIdRequest, GetSeasonByTitleRequest, GetSeriesByIdRequest, GetSeriesByTitleRequest, SearchMovieRequest, SearchRequestBase, SearchSeriesRequest

public interface QueryParameterBasedRequest

Defines a request that contain parameters to be constructed as query parameters in an HTTP request.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_RESPONSE_TYPE

Method Summary

Modifier and Type	Method	Description
static okhttp3.HttpUrl.Builder	appendIfNotBlank(okhttp3.HttpUrl.Builder urlBuilder, String name, String value)	Helper method to populate a query parameter if the string value is not blank.
static okhttp3.HttpUrl.Builder	appendIfNotNull(okhttp3.HttpUrl.Builder urlBuilder, String name, Object value)	Helper method to populate a query parameter if the value is not null.
okhttp3.HttpUrl.Builder	populateQueryParameters(okhttp3.HttpUrl.Builder urlBuilder)	Helper method to populate query parameters of a HttpUrl.Builder.

Field Details

JSON_RESPONSE_TYPE

static final String JSON_RESPONSE_TYPE

See Also:

• Constant Field Values

Method Details

populateQueryParameters

okhttp3.HttpUrl.Builder populateQueryParameters(okhttp3.HttpUrl.Builder urlBuilder)

Helper method to populate query parameters of a HttpUrl.Builder.

Parameters:

urlBuilder - the HttpUrl.Builder instance

Returns:

the HttpUrl.Builder instance

appendIfNotNull

static okhttp3.HttpUrl.Builder appendIfNotNull(okhttp3.HttpUrl.Builder urlBuilder,
 String name,
 Object value)

Helper method to populate a query parameter if the value is not null.

Parameters:

urlBuilder - the URL builder

name - the query parameter name

value - the query parameter value

Returns:

the builder

appendIfNotBlank

static okhttp3.HttpUrl.Builder appendIfNotBlank(okhttp3.HttpUrl.Builder urlBuilder,
 String name,
 String value)

Helper method to populate a query parameter if the string value is not blank.

Parameters:

urlBuilder - the URL builder

name - the query parameter name

value - the query parameter value

Returns:

the builder