Package se.michaelthelin.spotify.model_objects.specification

Class PagingCursorbased<T>

java.lang.Object

se.michaelthelin.spotify.model_objects.AbstractModelObject

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

Type Parameters:

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

All Implemented Interfaces:

Serializable, IModelObject

public class PagingCursorbased<T>
extends AbstractModelObject

Retrieve information about cursor-based Paging objects by building instances from this class.
This cursor-based paging object is a container for a set of objects.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	PagingCursorbased.Builder<T>	Builder class for building PagingCursorbased instances.
static final class	PagingCursorbased.JsonUtil<X>	JsonUtil class for building PagingCursorbased instances.

Nested classes/interfaces inherited from interface se.michaelthelin.spotify.model_objects.IModelObject

IModelObject.IJsonUtil<T>

Method Summary

Modifier and Type	Method	Description
PagingCursorbased.Builder<T>	builder()	Create a builder for building an instance of a model object.
Cursor[]	getCursors()	Get the cursors used to find the next set of items.
String	getHref()	Get a link to the Web API endpoint returning the full result of the request.
T[]	getItems()	Get the items contained in the paging object.
Integer	getLimit()	Get the maximum number of items in the response (as set in the query or by default).
String	getNext()	Get the URL to the next page of items.
Integer	getTotal()	Get the total number of items available to return.
String	toString()	Returns a String representation of this model object in the style:

Methods inherited from class java.lang.Object

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

Method Details

getHref

public String getHref()

Get a link to the Web API endpoint returning the full result of the request.

Returns:

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

getItems

public T[] getItems()

Get the items contained in the paging object.

Returns:

The items contained in the paging object.

getLimit

public Integer getLimit()

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

Returns:

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

getNext

public String getNext()

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

Returns:

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

getCursors

public Cursor[] getCursors()

Get the cursors used to find the next set of items.

Returns:

The cursors used to find the next set of items.

getTotal

public Integer getTotal()

Get the total number of items available to return.

Returns:

The total number of items available to return.

toString

public String toString()

Description copied from class: AbstractModelObject

Returns a String representation of this model object in the style:

ModelObject(attr1=value1, attr2=value2, ...)

Specified by:

toString in class AbstractModelObject

builder

public PagingCursorbased.Builder<T> builder()

Description copied from interface: IModelObject

Create a builder for building an instance of a model object.
The type of the builder and its methods depend on its corresponding implementation.

Returns:

A builder object.