se.michaelthelin.spotify.model_objects.miscellaneous.SavedEpisode 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.miscellaneous;

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.specification.Episode;

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

/**
 * Retrieve information about saved episode object by building instances from this class.
 */
@JsonDeserialize(builder = SavedEpisode.Builder.class)
public class SavedEpisode extends AbstractModelObject {
  private final Date addedAt;
  private final Episode episode;

  private SavedEpisode(final SavedEpisode.Builder builder) {
    super(builder);
    this.addedAt = builder.addedAt;
    this.episode = builder.episode;
  }

  /**
   * Get the date, when the episode has been saved.
   *
   * @return The date and time the episode was saved.
   */
  public Date getAddedAt() {
    return addedAt;
  }

  /**
   * Get information about the episode from a saved episode object.
   *
   * @return Information about the episode.
   */
  public Episode getEpisode() {
    return episode;
  }

  @Override
  public String toString() {
    return "SavedEpisode(addedAt=" + addedAt + ", episode=" + episode + ")";
  }

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

  /**
   * Builder class for building {@link SavedEpisode} instances.
   */
  public static final class Builder extends AbstractModelObject.Builder {
    private Date addedAt;
    private Episode episode;

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

    /**
     * Set the full episode object of the saved episode to be built.
     *
     * @param episode Information about the episode.
     * @return A {@link SavedEpisode.Builder}.
     */
    public SavedEpisode.Builder setEpisode(Episode episode) {
      this.episode = episode;
      return this;
    }

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

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

      try {
        return new Builder()
          .setAddedAt(
            hasAndNotNull(jsonObject, "added_at")
              ? SpotifyApi.parseDefaultDate(jsonObject.get("added_at").getAsString())
              : null)
          .setEpisode(
            hasAndNotNull(jsonObject, "episode")
              ? new Episode.JsonUtil().createModelObject(
              jsonObject.getAsJsonObject("episode"))
              : null)
          .build();
      } catch (ParseException e) {
        SpotifyApi.LOGGER.log(Level.SEVERE, e.getMessage());
        return null;
      }
    }
  }
}