se.michaelthelin.spotify.model_objects.specification.PlaylistTrack 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
A Java client for Spotify's Web API
There is a newer version: 9.0.0-RC1
package se.michaelthelin.spotify.model_objects.specification;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.google.gson.JsonObject;
import se.michaelthelin.spotify.SpotifyApi;
import se.michaelthelin.spotify.model_objects.AbstractModelObject;
import se.michaelthelin.spotify.model_objects.IPlaylistItem;

import java.text.ParseException;
import java.util.Date;
import java.util.logging.Level;

/**
 * Retrieve information about 
 * Playlist Track objects by building instances from this class.
 */
@JsonDeserialize(builder = PlaylistTrack.Builder.class)
public class PlaylistTrack extends AbstractModelObject {
  private final Date addedAt;
  private final User addedBy;
  private final Boolean isLocal;
  private final IPlaylistItem track;

  private PlaylistTrack(final Builder builder) {
    super(builder);

    this.addedAt = builder.addedAt;
    this.addedBy = builder.addedBy;
    this.isLocal = builder.isLocal;
    this.track = builder.track;
  }

  /**
   * Get the date, when the track or episode has been added to its playlist.
   * Note: Some very old playlists may return {@code null} in this field.
   *
   * @return The date and time the track or episode was added.
   */
  public Date getAddedAt() {
    return addedAt;
  }

  /**
   * Get the user, who added the track or episode to its playlist.
   * Note: Some very old playlists may return null in this field.
   *
   * @return The Spotify user who added the track or episode.
   */
  public User getAddedBy() {
    return addedBy;
  }

  /**
   * Check whether a playlist track is a local track or episode or not.

   * Local tracks can only be played on devices, where the track files are present.
   *
   * @return Whether this track is a local file or not.
   */
  public Boolean getIsLocal() {
    return isLocal;
  }

  /**
   * Get a full track or episode object from this playlist track object.
   *
   * @return Information about the track.
   */
  public IPlaylistItem getTrack() {
    return track;
  }

  @Override
  public String toString() {
    return "PlaylistTrack(track=" + track + ", addedAt=" + addedAt + ", addedBy=" + addedBy + ", isLocal=" + isLocal
        + ")";
  }

  @Override
  public Builder builder() {
    return new Builder();
  }

  /**
   * Builder class for building {@link PlaylistTrack} instances.
   */
  public static final class Builder extends AbstractModelObject.Builder {
    private Date addedAt;
    private User addedBy;
    private Boolean isLocal;
    private IPlaylistItem track;

    /**
     * Set the "added at" date of the playlist track to be built.
     *
     * @param addedAt The date and time the track or episode was added.
     * @return A {@link PlaylistTrack.Builder}.
     */
    public Builder setAddedAt(Date addedAt) {
      this.addedAt = addedAt;
      return this;
    }

    /**
     * Set the user who added the track or episode to the playlist.
     *
     * @param addedBy The Spotify user who added the track or episode.
     * @return A {@link PlaylistTrack.Builder}.
     */
    public Builder setAddedBy(User addedBy) {
      this.addedBy = addedBy;
      return this;
    }

    /**
     * Set whether the track to be built is local or not.
     *
     * @param isLocal Whether this track or episode is a local file or not.
     * @return A {@link PlaylistTrack.Builder}.
     */
    public Builder setIsLocal(Boolean isLocal) {
      this.isLocal = isLocal;
      return this;
    }

    /**
     * Set the full track or episode object of the playlist track to be built.
     *
     * @param track Information about the track.
     * @return A {@link PlaylistTrack.Builder}.
     */
    public Builder setTrack(IPlaylistItem track) {
      this.track = track;
      return this;
    }

    @Override
    public PlaylistTrack build() {
      return new PlaylistTrack(this);
    }
  }

  /**
   * JsonUtil class for building {@link PlaylistTrack} instances.
   */
  public static final class JsonUtil extends AbstractModelObject.JsonUtil {
    public PlaylistTrack createModelObject(JsonObject jsonObject) {
      if (jsonObject == null || jsonObject.isJsonNull()) {
        return null;
      }

      try {
        IPlaylistItem track = null;

        if (hasAndNotNull(jsonObject, "track")) {
          final JsonObject trackObj = jsonObject.getAsJsonObject("track");

          if (hasAndNotNull(trackObj, "type")) {
            String type = trackObj.get("type").getAsString().toLowerCase();

            if (type.equals("track")) {
              track = new Track.JsonUtil().createModelObject(trackObj);
            } else if (type.equals("episode")) {
              track = new Episode.JsonUtil().createModelObject(trackObj);
            }
          }
        }

        return new Builder()
          .setAddedAt(
            hasAndNotNull(jsonObject, "added_at")
              ? SpotifyApi.parseDefaultDate(jsonObject.get("added_at").getAsString())
              : null)
          .setAddedBy(
            hasAndNotNull(jsonObject, "added_by")
              ? new User.JsonUtil().createModelObject(
              jsonObject.get("added_by").getAsJsonObject())
              : null)
          .setIsLocal(
            hasAndNotNull(jsonObject, "is_local")
              ? jsonObject.get("is_local").getAsBoolean()
              : null)
          .setTrack(track)
          .build();
      } catch (ParseException e) {
        SpotifyApi.LOGGER.log(Level.SEVERE, e.getMessage());
        return null;
      }
    }
  }
}