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

import java.util.Objects;

/**
 * Retrieve information about Device
 * objects by creating instances from this class.
 */
@JsonDeserialize(builder = Device.Builder.class)
public class Device extends AbstractModelObject {
  private final String id;
  private final Boolean is_active;
  private final Boolean is_private_session;
  private final Boolean is_restricted;
  private final String name;
  private final Boolean supports_volume;
  private final String type;
  private final Integer volume_percent;

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

    this.id = builder.id;
    this.is_active = builder.is_active;
    this.is_private_session = builder.is_private_session;
    this.is_restricted = builder.is_restricted;
    this.name = builder.name;
    this.supports_volume = builder.supports_volume;
    this.type = builder.type;
    this.volume_percent = builder.volume_percent;
  }

  /**
   * Get the ID of the device.
   *
   * @return The device ID. This may be {@code null}.
   */
  public String getId() {
    return id;
  }

  /**
   * Check whether the device is the currently active device.
   *
   * @return If this device is the currently active device.
   */
  public Boolean getIs_active() {
    return is_active;
  }

  /**
   * Get whether the device is in a private session. Access to playback info is limited on clients in a private session.
   *
   * @return Whether the user has put the client into a private session.
   */
  public Boolean getIs_private_session() {
    return is_private_session;
  }

  /**
   * Check whether the device is restricted or not. Restricted devices don't accept Spotify Web API calls.
   *
   * @return Whether controlling this device is restricted.
   */
  public Boolean getIs_restricted() {
    return is_restricted;
  }

  /**
   * Get the name of the device.
   *
   * @return The name of the device.
   */
  public String getName() {
    return name;
  }

  /**
   * Check whether the device can be used to set the volume.
   *
   * @return If this device can be used to set the volume.
   */
  public Boolean getSupports_volume() {
    return supports_volume;
  }

  /**
   * Get the type of the device.
   *
   * @return Device type, such as "Computer", "Smartphone" or "Speaker".
   */
  public String getType() {
    return type;
  }

  /**
   * Get the current volume of the device in percent.
   *
   * @return The current volume in percent. This may be {@code null}.
   */
  public Integer getVolume_percent() {
    return volume_percent;
  }

  @Override
  public String toString() {
    return "Device(id=" + id + ", is_active=" + is_active + ", is_private_session=" + is_private_session + ", is_restricted=" + is_restricted + ", name=" + name
      + ", supports_volume=" + supports_volume + ", type=" + type + ", volume_percent=" + volume_percent + ")";
  }

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

  /**
   * Builder class for building {@link Device} instances.
   */
  public static final class Builder extends AbstractModelObject.Builder {
    private String id;
    private Boolean is_active;
    private Boolean is_private_session;
    private Boolean is_restricted;
    private String name;
    private Boolean supports_volume;
    private String type;
    private Integer volume_percent;

    /**
     * The device ID setter.
     *
     * @param id The device ID. This may be {@code null}.
     * @return A {@link Device.Builder}.
     */
    public Builder setId(String id) {
      this.id = id;
      return this;
    }

    /**
     * The active device state setter.
     *
     * @param is_active If this device is the currently active device.
     * @return A {@link Device.Builder}.
     */
    public Builder setIs_active(Boolean is_active) {
      this.is_active = is_active;
      return this;
    }

    /**
     * The private session state setter.
     *
     * @param is_private_session If this device is currently in a private session.
     * @return A {@link Device.Builder}.
     */
    public Builder setIs_private_session(Boolean is_private_session) {
      this.is_private_session = is_private_session;
      return this;
    }

    /**
     * The device restriction state setter.
     *
     * @param is_restricted Whether controlling this device is restricted.
     * @return A {@link Device.Builder}.
     */
    public Builder setIs_restricted(Boolean is_restricted) {
      this.is_restricted = is_restricted;
      return this;
    }

    /**
     * The device name setter.
     *
     * @param name The name of the device.
     * @return A {@link Device.Builder}.
     */
    public Builder setName(String name) {
      this.name = name;
      return this;
    }

    /**
     * The supports volume state setter.
     *
     * @param supports_volume If this device can be used to set the volume.
     * @return A {@link Device.Builder}.
     */
    public Builder setSupports_volume(Boolean supports_volume) {
      this.supports_volume = supports_volume;
      return this;
    }

    /**
     * The device type setter.
     *
     * @param type Device type, such as "Computer", "Smartphone" or "Speaker".
     * @return A {@link Device.Builder}.
     */
    public Builder setType(String type) {
      this.type = type;
      return this;
    }

    /**
     * The device volume setter.
     *
     * @param volume_percent The current volume in percent. This may be {@code null}.
     * @return A {@link Device.Builder}.
     */
    public Builder setVolume_percent(Integer volume_percent) {
      this.volume_percent = volume_percent;
      return this;
    }

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

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

      return new Device.Builder()
        .setId(
          hasAndNotNull(jsonObject, "id")
            ? jsonObject.get("id").getAsString()
            : null)
        .setIs_active(
          hasAndNotNull(jsonObject, "is_active")
            ? jsonObject.get("is_active").getAsBoolean()
            : null)
        .setIs_private_session(
          hasAndNotNull(jsonObject, "is_private_session")
            ? jsonObject.get("is_private_session").getAsBoolean()
            : null)
        .setIs_restricted(
          hasAndNotNull(jsonObject, "is_restricted")
            ? jsonObject.get("is_restricted").getAsBoolean()
            : null)
        .setName(
          hasAndNotNull(jsonObject, "name")
            ? jsonObject.get("name").getAsString()
            : null)
        .setSupports_volume(
          hasAndNotNull(jsonObject, "supports_volume")
            ? jsonObject.get("supports_volume").getAsBoolean()
            : null)
        .setType(
          hasAndNotNull(jsonObject, "type")
            ? jsonObject.get("type").getAsString()
            : null)
        .setVolume_percent(
          hasAndNotNull(jsonObject, "volume_percent")
            ? jsonObject.get("volume_percent").getAsInt()
            : null)
        .build();
    }
  }

  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    Device device = (Device) o;
    return Objects.equals(id, device.id) && Objects.equals(name, device.name);
  }

  @Override
  public int hashCode() {
    return Objects.hash(id, name);
  }
}