Package com.wrapper.spotify.requests.data.browse

Class GetCategoryRequest.Builder

java.lang.Object

com.wrapper.spotify.requests.AbstractRequest.Builder<T,BT>

com.wrapper.spotify.requests.data.AbstractDataRequest.Builder<Category,GetCategoryRequest.Builder>

com.wrapper.spotify.requests.data.browse.GetCategoryRequest.Builder

All Implemented Interfaces:

IRequest.Builder<Category,GetCategoryRequest.Builder>

Enclosing class:

GetCategoryRequest

public static final class GetCategoryRequest.Builder
extends AbstractDataRequest.Builder<Category,GetCategoryRequest.Builder>

Builder class for building a GetCategoryRequest.

Constructor Summary

Constructors

Constructor	Description
Builder(String accessToken)	Create a new GetCategoryRequest.Builder instance.

Method Summary

Modifier and Type	Method	Description
GetCategoryRequest	build()	The request build method.
GetCategoryRequest.Builder	category_id(String category_id)	The category ID setter.
GetCategoryRequest.Builder	country(com.neovisionaries.i18n.CountryCode country)	The country code setter.
GetCategoryRequest.Builder	locale(String locale)	The language code setter.
protected GetCategoryRequest.Builder	self()	Return this instance to simulate a self-type.

Methods inherited from class com.wrapper.spotify.requests.AbstractRequest.Builder

setBody, setBodyParameter, setContentType, setDefaults, setHeader, setHost, setHttpManager, setPath, setPathParameter, setPort, setQueryParameter, setScheme

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(String accessToken)

Create a new GetCategoryRequest.Builder instance.

Parameters:

accessToken - Required. A valid access token from the Spotify Accounts service.

Method Details

category_id

public GetCategoryRequest.Builder category_id(String category_id)

The category ID setter.

Parameters:

category_id - The Spotify category ID for the category.

Returns:

A GetCategoryRequest.Builder.

See Also:

Spotify URIs & IDs

country

public GetCategoryRequest.Builder country(com.neovisionaries.i18n.CountryCode country)

The country code setter.

Parameters:

country - Optional. A country: an ISO 3166-1 alpha-2 country code. Provide this parameter if you want to narrow the list of returned categories to those relevant to a particular country. If omitted, the returned items will be globally relevant.

Returns:

A GetCategoryRequest.Builder.

See Also:

Wikipedia: ISO 3166-1 alpha-2 country codes

locale

public GetCategoryRequest.Builder locale(String locale)

The language code setter.

Parameters:

locale - Optional. The desired language, consisting of an ISO 639 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore. For example: es_MX, meaning "Spanish (Mexico)". Provide this parameter if you want the category metadata returned in a particular language. Note that, if locale is not supplied, or if the specified language is not available, all strings will be returned in the Spotify default language (American English). The locale parameter, combined with the country parameter, may give odd results if not carefully matched. For example country=SE&locale=de_DE will return a list of categories relevant to Sweden but as German language strings.

Returns:

A GetCategoryRequest.Builder

See Also:

Wikipedia: ISO 3166-1 alpha-2 country codes, Wikipedia: ISO 639 language code

build

public GetCategoryRequest build()

The request build method.

Returns:

A custom GetCategoryRequest.

self

protected GetCategoryRequest.Builder self()

Description copied from class: AbstractRequest.Builder

Return this instance to simulate a self-type.

Specified by:

self in class AbstractRequest.Builder<Category,GetCategoryRequest.Builder>

Returns:

This instance.