Class Playlist

java.lang.Object

se.michaelthelin.spotify.model_objects.AbstractModelObject

se.michaelthelin.spotify.model_objects.specification.Playlist

All Implemented Interfaces:

Serializable, IModelObject, IPlaylist<Paging<PlaylistTrack>>

public class Playlist
extends AbstractModelObject
implements IPlaylist<Paging<PlaylistTrack>>

Retrieve information about Playlist objects by building instances from this class.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Playlist.Builder	Builder class for building Playlist instances.
static final class	Playlist.JsonUtil	JsonUtil class for building Playlist instances.

Nested classes/interfaces inherited from interface IModelObject

IModelObject.IJsonUtil<T>

Method Summary

Modifier and Type	Method	Description
Playlist.Builder	builder()	Create a builder for building an instance of a model object.
boolean	equals(Object o)
String	getDescription()	Get the description of the playlist.
ExternalUrl	getExternalUrls()	Get the external URLs of the playlist.
Followers	getFollowers()	Get information about the followers of the playlist.
String	getHref()	Get the full Spotify API endpoint url of the playlist.
String	getId()	Get the Spotify ID of a playlist.
Image[]	getImages()	Images for the playlist.
Boolean	getIsCollaborative()	Check whether the playlist is collaborative or not.
Paging<PlaylistTrack>	getItems()	Get information about the tracks of the playlist.
String	getName()	Get the name of a playlist.
User	getOwner()	Get the owners user object of a playlist.
Boolean	getPublic()	Check whether a playlist is available in public or is private.
String	getSnapshotId()	Get the snapshot ID, the version identifier for the current playlist.
ModelObjectType	getType()	Get the model object type.
String	getUri()	Get the Spotify URI of a playlist.
int	hashCode()
String	toString()	Returns a String representation of this model object in the style:

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getIsCollaborative

public Boolean getIsCollaborative()

Check whether the playlist is collaborative or not.

Specified by:

getIsCollaborative in interface IPlaylist<Paging<PlaylistTrack>>

Returns:

true if the owner allows other users to modify the playlist, false if not.

See Also:

• Spotify: Working With Playlists

getDescription

public String getDescription()

Get the description of the playlist.

Specified by:

getDescription in interface IPlaylist<Paging<PlaylistTrack>>

Returns:

The playlist description. Only returned for modified, verified playlists, otherwise null.

getExternalUrls

public ExternalUrl getExternalUrls()

Get the external URLs of the playlist.
Example: Spotify-URL.

Specified by:

getExternalUrls in interface IPlaylist<Paging<PlaylistTrack>>

Returns:

Known external URLs for this playlist.

getFollowers

public Followers getFollowers()

Get information about the followers of the playlist.
Example: Follower count.

Returns:

Information about the followers of the playlist.

getHref

public String getHref()

Get the full Spotify API endpoint url of the playlist.

Specified by:

getHref in interface IPlaylist<Paging<PlaylistTrack>>

Returns:

A link to the Web API endpoint providing full details of the playlist.

getId

public String getId()

Get the Spotify ID of a playlist.

Specified by:

getId in interface IPlaylist<Paging<PlaylistTrack>>

Returns:

The Spotify ID for the playlist.

getImages

public Image[] getImages()

Images for the playlist. The array may be empty or contain up to three images. The images are returned by size in descending order.
Note: If returned, the source URL for the image is temporary and will expire in less than a day.

Specified by:

getImages in interface IPlaylist<Paging<PlaylistTrack>>

Returns:

An array of images in different sizes.

See Also:

• Spotify: Working With Playlists

getName

public String getName()

Get the name of a playlist.

Specified by:

getName in interface IPlaylist<Paging<PlaylistTrack>>

Returns:

Playlist name.

getOwner

public User getOwner()

Get the owners user object of a playlist.

Specified by:

getOwner in interface IPlaylist<Paging<PlaylistTrack>>

Returns:

A user object.

getPublic

public Boolean getPublic()

Check whether a playlist is available in public or is private.

Specified by:

getPublic in interface IPlaylist<Paging<PlaylistTrack>>

Returns:

true the playlist is public, false the playlist is private, null the playlist status is not relevant.

See Also:

• Spotify: Working With Playlists

getSnapshotId

public String getSnapshotId()

Get the snapshot ID, the version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version.

Specified by:

getSnapshotId in interface IPlaylist<Paging<PlaylistTrack>>

Returns:

The version identifier for the current playlist.

See Also:

• RemovePlaylistItemsRequest

getItems

public Paging<PlaylistTrack> getItems()

Get information about the tracks of the playlist.

Specified by:

getItems in interface IPlaylist<Paging<PlaylistTrack>>

Returns:

Information about the tracks of the playlist.

getType

public ModelObjectType getType()

Get the model object type. In this case "playlist".

Specified by:

getType in interface IPlaylist<Paging<PlaylistTrack>>

Returns:

The object type: "playlist"

getUri

public String getUri()

Get the Spotify URI of a playlist.

Specified by:

getUri in interface IPlaylist<Paging<PlaylistTrack>>

Returns:

Spotify playlist URI.

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 Playlist.Builder 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.

Specified by:

builder in interface IModelObject

Returns:

A builder object.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object