Package se.michaelthelin.spotify.model_objects.specification

Class PagingCursorbased.Builder<T>

java.lang.Object

se.michaelthelin.spotify.model_objects.AbstractModelObject.Builder

se.michaelthelin.spotify.model_objects.specification.PagingCursorbased.Builder<T>

Type Parameters:

T - The type of the objects contained in a paging object.

All Implemented Interfaces:

IModelObject.Builder

Enclosing class:

PagingCursorbased<T>

public static final class PagingCursorbased.Builder<T>
extends AbstractModelObject.Builder

Builder class for building PagingCursorbased instances.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PagingCursorbased<T>	build()	Build a model object with the information set in the builder object.
PagingCursorbased.Builder<T>	setCursors(Cursor... cursors)	The cursor setter.
PagingCursorbased.Builder<T>	setHref(String href)	The href setter.
PagingCursorbased.Builder<T>	setItems(T[] items)	The items setter.
PagingCursorbased.Builder<T>	setLimit(Integer limit)	The request limit setter.
PagingCursorbased.Builder<T>	setNext(String next)	The next URL setter.
PagingCursorbased.Builder<T>	setTotal(Integer total)	The total amount setter.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

setHref

public PagingCursorbased.Builder<T> setHref(String href)

The href setter.

Parameters:

href - A link to the Web API endpoint returning the full result of the request.

Returns:

A PagingCursorbased.Builder.

setItems

public PagingCursorbased.Builder<T> setItems(T[] items)

The items setter.

Parameters:

items - A page of items.

Returns:

A PagingCursorbased.Builder.

setLimit

public PagingCursorbased.Builder<T> setLimit(Integer limit)

The request limit setter.

Parameters:

limit - The maximum number of items in the response (as set in the query or by default).

Returns:

A PagingCursorbased.Builder.

setNext

public PagingCursorbased.Builder<T> setNext(String next)

The next URL setter.

Parameters:

next - URL to the next page of items. (null if none)

Returns:

A PagingCursorbased.Builder.

setCursors

public PagingCursorbased.Builder<T> setCursors(Cursor... cursors)

The cursor setter.

Parameters:

cursors - The cursors used to find the next set of items.

Returns:

A PagingCursorbased.Builder.

setTotal

public PagingCursorbased.Builder<T> setTotal(Integer total)

The total amount setter.

Parameters:

total - The total number of items available to return.

Returns:

A PagingCursorbased.Builder.

build

public PagingCursorbased<T> build()

Description copied from interface: IModelObject.Builder

Build a model object with the information set in the builder object.
The type of the model object and its methods depend on its corresponding implementation.

Returns:

A model object.