Class Paging<T>
java.lang.Object
se.michaelthelin.spotify.model_objects.AbstractModelObject
se.michaelthelin.spotify.model_objects.specification.Paging<T>
- Type Parameters:
T
- The type of the objects contained in a paging object.
- All Implemented Interfaces:
Serializable
,IModelObject
Retrieve information about
Paging objects
by building instances from this class.
This offset-based paging object is a container for a set of objects.
This offset-based paging object is a container for a set of objects.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Builder class for buildingPaging
instances.static final class
JsonUtil class for buildingPaging
instances.Nested classes/interfaces inherited from interface se.michaelthelin.spotify.model_objects.IModelObject
IModelObject.IJsonUtil<T>
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder for building an instance of a model object.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.getLimit()
Get the maximum number of items in the response (as set in the query or by default).getNext()
Get the URL to the next page of items.Get the offset of the items returned (as set in the query or by default).Get the URL to the previous page of items.getTotal()
Get the total number of items available to return.toString()
Returns a String representation of this model object in the style:
-
Method Details
-
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
Get the items contained in the paging object.- Returns:
- The items contained in the paging object.
-
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
Get the URL to the next page of items. (null
if none)- Returns:
- URL to the next page of items. (
null
if none)
-
getOffset
Get the offset of the items returned (as set in the query or by default).- Returns:
- The offset of the items returned (as set in the query or by default).
-
getPrevious
Get the URL to the previous page of items. (null
if none)- Returns:
- URL to the previous page of items. (
null
if none)
-
getTotal
Get the total number of items available to return.- Returns:
- The total number of items available to return.
-
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 classAbstractModelObject
-
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.
-