se.michaelthelin.spotify.model_objects.specification.Playlist Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spotify-web-api-java Show documentation
Show all versions of spotify-web-api-java Show documentation
A Java client for Spotify's Web API
package se.michaelthelin.spotify.model_objects.specification;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.google.gson.JsonObject;
import se.michaelthelin.spotify.enums.ModelObjectType;
import se.michaelthelin.spotify.model_objects.AbstractModelObject;
import se.michaelthelin.spotify.requests.data.playlists.RemoveItemsFromPlaylistRequest;
import java.util.Arrays;
import java.util.Objects;
/**
* Retrieve information about
* Playlist objects by building instances from this class.
*/
@JsonDeserialize(builder = Playlist.Builder.class)
public class Playlist extends AbstractModelObject {
private final Boolean collaborative;
private final String description;
private final ExternalUrl externalUrls;
private final Followers followers;
private final String href;
private final String id;
private final Image[] images;
private final String name;
private final User owner;
private final Boolean publicAccess;
private final String snapshotId;
private final Paging tracks;
private final ModelObjectType type;
private final String uri;
private Playlist(final Builder builder) {
super(builder);
this.collaborative = builder.collaborative;
this.description = builder.description;
this.externalUrls = builder.externalUrls;
this.followers = builder.followers;
this.href = builder.href;
this.id = builder.id;
this.images = builder.images;
this.name = builder.name;
this.owner = builder.owner;
this.publicAccess = builder.publicAccess;
this.snapshotId = builder.snapshotId;
this.tracks = builder.tracks;
this.type = builder.type;
this.uri = builder.uri;
}
/**
* Check whether the playlist is collaborative or not.
*
* @return {@code true} if the owner allows other users to modify the playlist, {@code false} if not.
* @see
* Spotify: Working With Playlists
*/
public Boolean getIsCollaborative() {
return collaborative;
}
/**
* Get the description of the playlist.
*
* @return The playlist description. Only returned for modified, verified playlists, otherwise {@code null}.
*/
public String getDescription() {
return description;
}
/**
* Get the external URLs of the playlist.
* Example: Spotify-URL.
*
* @return Known external URLs for this playlist.
*/
public ExternalUrl getExternalUrls() {
return externalUrls;
}
/**
* Get information about the followers of the playlist.
* Example: Follower count.
*
* @return Information about the followers of the playlist.
*/
public Followers getFollowers() {
return followers;
}
/**
* Get the full Spotify API endpoint url of the playlist.
*
* @return A link to the Web API endpoint providing full details of the playlist.
*/
public String getHref() {
return href;
}
/**
* Get the Spotify ID
* of a playlist.
*
* @return The Spotify ID for the playlist.
*/
public String getId() {
return id;
}
/**
* 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.
*
* @return An array of images in different sizes.
* @see
* Spotify: Working With Playlists
*/
public Image[] getImages() {
return images;
}
/**
* Get the name of a playlist.
*
* @return Playlist name.
*/
public String getName() {
return name;
}
/**
* Get the owners user object of a playlist.
*
* @return A user object.
*/
public User getOwner() {
return owner;
}
/**
* Check whether a playlist is available in public or is private.
*
* @return {@code true} the playlist is public, {@code false} the playlist is private, {@code null}
* the playlist status is not relevant.
* @see
* Spotify: Working With Playlists
*/
public Boolean getIsPublicAccess() {
return publicAccess;
}
/**
* Get the snapshot ID, the version identifier for the current playlist. Can be supplied in other requests to target
* a specific playlist version.
*
* @return The version identifier for the current playlist.
* @see RemoveItemsFromPlaylistRequest
*/
public String getSnapshotId() {
return snapshotId;
}
/**
* Get information about the tracks of the playlist.
*
* @return Information about the tracks of the playlist.
*/
public Paging getTracks() {
return tracks;
}
/**
* Get the model object type. In this case "playlist".
*
* @return The object type: "playlist"
*/
public ModelObjectType getType() {
return type;
}
/**
* Get the Spotify URI
* of a playlist.
*
* @return Spotify playlist URI.
*/
public String getUri() {
return uri;
}
@Override
public String toString() {
return "Playlist(name=" + name + ", description=" + description + ", tracks=" + tracks + ", collaborative="
+ collaborative + ", externalUrls=" + externalUrls + ", followers=" + followers + ", href=" + href + ", id="
+ id + ", images=" + Arrays.toString(images) + ", owner=" + owner + ", publicAccess=" + publicAccess
+ ", snapshotId=" + snapshotId + ", type=" + type + ", uri=" + uri + ")";
}
@Override
public Builder builder() {
return new Builder();
}
/**
* Builder class for building {@link Playlist} instances.
*/
public static final class Builder extends AbstractModelObject.Builder {
private Boolean collaborative;
private String description;
private ExternalUrl externalUrls;
private Followers followers;
private String href;
private String id;
private Image[] images;
private String name;
private User owner;
private Boolean publicAccess;
private String snapshotId;
private Paging tracks;
private ModelObjectType type;
private String uri;
/**
* Set whether the playlist to be built is collaborative or not.
*
* @param collaborative {@code true} if the owner allows other users to modify the playlist, {@code false} if not.
* @return A {@link Playlist.Builder}.
*/
public Builder setCollaborative(Boolean collaborative) {
this.collaborative = collaborative;
return this;
}
/**
* Set the description of the playlist to be built.
*
* @param description Playlist description.
* @return A {@link Playlist.Builder}.
*/
public Builder setDescription(String description) {
this.description = description;
return this;
}
/**
* Set the external URLs of the playlist to be built.
*
* @param externalUrls Known external URLs for this playlist.
* @return A {@link Playlist.Builder}.
*/
public Builder setExternalUrls(ExternalUrl externalUrls) {
this.externalUrls = externalUrls;
return this;
}
/**
* Set information about the followers of the playlist to be built.
*
* @param followers Information about the followers of the playlist.
* @return A {@link Playlist.Builder}.
*/
public Builder setFollowers(Followers followers) {
this.followers = followers;
return this;
}
/**
* Set the link to the Spotify Web API endpoint providing full details of the playlist.
*
* @param href A link to the Spotify Web API endpoint providing full details of the playlist.
* @return A {@link Playlist.Builder}.
*/
public Builder setHref(String href) {
this.href = href;
return this;
}
/**
* Set the Spotify ID for the playlist to be built.
*
* @param id The Spotify ID for the playlist.
* @return A {@link Playlist.Builder}.
*/
public Builder setId(String id) {
this.id = id;
return this;
}
/**
* Set the cover image of the playlist to be built.
*
* @param images An array of images in different sizes.
* @return A {@link Playlist.Builder}.
*/
public Builder setImages(Image... images) {
this.images = images;
return this;
}
/**
* Set the name of the playlist to be built.
*
* @param name The playlist name.
* @return A {@link Playlist.Builder}.
*/
public Builder setName(String name) {
this.name = name;
return this;
}
/**
* Set the owner of the playlist to be built.
*
* @param owner A user object.
* @return A {@link Playlist.Builder}.
*/
public Builder setOwner(User owner) {
this.owner = owner;
return this;
}
/**
* Set whether the playlist to be built is available in public or not.
*
* @param publicAccess {@code true} the playlist is public, {@code false} the playlist is private, {@code null}
* the playlist status is not relevant.
* @return A {@link Playlist.Builder}.
*/
public Builder setPublicAccess(Boolean publicAccess) {
this.publicAccess = publicAccess;
return this;
}
/**
* Set the version identifier for the playlist to be built.
*
* @param snapshotId The version identifier for the playlist.
* @return A {@link Playlist.Builder}.
*/
public Builder setSnapshotId(String snapshotId) {
this.snapshotId = snapshotId;
return this;
}
/**
* Set the tracks of the playlist to be built.
*
* @param tracks Information about the tracks of the playlist.
* @return A {@link Playlist.Builder}.
*/
public Builder setTracks(Paging tracks) {
this.tracks = tracks;
return this;
}
/**
* Set the type of the model object. In this case "playlist".
*
* @param type The model object type.
* @return A {@link Playlist.Builder}.
*/
public Builder setType(ModelObjectType type) {
this.type = type;
return this;
}
/**
* Set the Spotify URI
* of the playlist to be built.
*
* @param uri The Spotify playlist URI.
* @return A {@link Playlist.Builder}.
*/
public Builder setUri(String uri) {
this.uri = uri;
return this;
}
@Override
public Playlist build() {
return new Playlist(this);
}
}
/**
* JsonUtil class for building {@link Playlist} instances.
*/
public static final class JsonUtil extends AbstractModelObject.JsonUtil {
public Playlist createModelObject(JsonObject jsonObject) {
if (jsonObject == null || jsonObject.isJsonNull()) {
return null;
}
return new Playlist.Builder()
.setCollaborative(
hasAndNotNull(jsonObject, "collaborative")
? jsonObject.get("collaborative").getAsBoolean()
: null)
.setDescription(
hasAndNotNull(jsonObject, "description")
? jsonObject.get("description").getAsString()
: null)
.setExternalUrls(
hasAndNotNull(jsonObject, "external_urls")
? new ExternalUrl.JsonUtil().createModelObject(
jsonObject.getAsJsonObject("external_urls"))
: null)
.setFollowers(
hasAndNotNull(jsonObject, "followers")
? new Followers.JsonUtil().createModelObject(
jsonObject.getAsJsonObject("followers"))
: null)
.setHref(
hasAndNotNull(jsonObject, "href")
? jsonObject.get("href").getAsString()
: null)
.setId(
hasAndNotNull(jsonObject, "id")
? jsonObject.get("id").getAsString()
: null)
.setImages(
hasAndNotNull(jsonObject, "images")
? new Image.JsonUtil().createModelObjectArray(
jsonObject.getAsJsonArray("images"))
: null)
.setName(
hasAndNotNull(jsonObject, "name")
? jsonObject.get("name").getAsString()
: null)
.setOwner(
hasAndNotNull(jsonObject, "owner")
? new User.JsonUtil().createModelObject(
jsonObject.getAsJsonObject("owner"))
: null)
.setPublicAccess(
hasAndNotNull(jsonObject, "public")
? jsonObject.get("public").getAsBoolean()
: null)
.setSnapshotId(
hasAndNotNull(jsonObject, "snapshot_id")
? jsonObject.get("snapshot_id").getAsString()
: null)
.setTracks(
hasAndNotNull(jsonObject, "tracks")
? new PlaylistTrack.JsonUtil().createModelObjectPaging(
jsonObject.getAsJsonObject("tracks"))
: null)
.setType(
hasAndNotNull(jsonObject, "type")
? ModelObjectType.keyOf(
jsonObject.get("type").getAsString().toLowerCase())
: null)
.setUri(
hasAndNotNull(jsonObject, "uri")
? jsonObject.get("uri").getAsString()
: null)
.build();
}
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Playlist playlist = (Playlist) o;
return Objects.equals(id, playlist.id) && Objects.equals(name, playlist.name) && Objects.equals(uri, playlist.uri);
}
@Override
public int hashCode() {
return Objects.hash(id, name, uri);
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy