com.wrapper.spotify.model_objects.special.AlbumSimplifiedSpecial Maven / Gradle / Ivy
package com.wrapper.spotify.model_objects.special;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.google.gson.Gson;
import com.google.gson.JsonObject;
import com.neovisionaries.i18n.CountryCode;
import com.wrapper.spotify.enums.AlbumType;
import com.wrapper.spotify.enums.ModelObjectType;
import com.wrapper.spotify.enums.ReleaseDatePrecision;
import com.wrapper.spotify.model_objects.AbstractModelObject;
import com.wrapper.spotify.model_objects.specification.Album;
import com.wrapper.spotify.model_objects.specification.ArtistSimplified;
import com.wrapper.spotify.model_objects.specification.ExternalUrl;
import com.wrapper.spotify.model_objects.specification.Image;
import com.wrapper.spotify.requests.data.search.interfaces.ISearchModelObject;
/**
* Retrieve information about
* simplified Album objects by building instances from this class.
*
* This class exists because it includes the property {@code totalTracks}, which is not documented in the official
* specification, although the albums object as returned by the searches API includes it.
*/
@JsonDeserialize(builder = AlbumSimplifiedSpecial.Builder.class)
public class AlbumSimplifiedSpecial extends AbstractModelObject implements ISearchModelObject {
private final AlbumType albumType;
private final ArtistSimplified[] artists;
private final CountryCode[] availableMarkets;
private final ExternalUrl externalUrls;
private final String href;
private final String id;
private final Image[] images;
private final String name;
private final String releaseDate;
private final ReleaseDatePrecision releaseDatePrecision;
private final int totalTracks;
private final ModelObjectType type;
private final String uri;
private AlbumSimplifiedSpecial(final Builder builder) {
super(builder);
this.albumType = builder.albumType;
this.artists = builder.artists;
this.availableMarkets = builder.availableMarkets;
this.externalUrls = builder.externalUrls;
this.href = builder.href;
this.id = builder.id;
this.images = builder.images;
this.name = builder.name;
this.releaseDate = builder.releaseDate;
this.releaseDatePrecision = builder.releaseDatePrecision;
this.totalTracks = builder.totalTracks;
this.type = builder.type;
this.uri = builder.uri;
}
/**
* Get the type of the album.
*
* @return The {@link AlbumType}.
*/
public AlbumType getAlbumType() {
return albumType;
}
/**
* Get the artists of the album.
*
* @return An array of {@link ArtistSimplified} objects.
*/
public ArtistSimplified[] getArtists() {
return artists;
}
/**
* Get the country codes of all countries, in which the album is available.
*
* @return An array of ISO 3166-1 alpha-2 country
* codes.
*/
public CountryCode[] getAvailableMarkets() {
return availableMarkets;
}
/**
* Get the external URLs of the album.
* Example: Spotify-URL
*
* @return An {@link ExternalUrl} object.
*/
public ExternalUrl getExternalUrls() {
return externalUrls;
}
/**
* Get the full Spotify Web API endpoint URL of the album.
*
* @return A Spotify Web API endpoint URL.
*/
public String getHref() {
return href;
}
/**
* Get the Spotify ID of the album.
*
* @return A Spotify album ID.
*/
public String getId() {
return id;
}
/**
* Get the album cover art of the album in different sizes.
*
* @return An array of {@link Image} objects.
*/
public Image[] getImages() {
return images;
}
/**
* Get the name of the album.
*
* @return Album name.
*/
public String getName() {
return name;
}
/**
* Get the release date of the album with the highest precision available.
*
* @return The release date of the album.
*/
public String getReleaseDate() {
return releaseDate;
}
/**
* Get the precision of the albums release date. This is needed when the exact release day of an album is not known.
*
* @return The precision of the albums release date.
*/
public ReleaseDatePrecision getReleaseDatePrecision() {
return releaseDatePrecision;
}
/**
* Get the total tracks of the album.
*
* @return The total tracks of the album.
*/
public int getTotalTracks() {
return totalTracks;
}
/**
* Get the model object type. In this case "album".
*
* @return A {@link ModelObjectType}.
*/
public ModelObjectType getType() {
return type;
}
/**
* Get the Spotify URI of the album.
*
* @return Spotify album URI.
*/
public String getUri() {
return uri;
}
@Override
public Builder builder() {
return new Builder();
}
/**
* Builder class for building {@link AlbumSimplifiedSpecial} instances.
*/
public static final class Builder extends AbstractModelObject.Builder {
private AlbumType albumType;
private ArtistSimplified[] artists;
private CountryCode[] availableMarkets;
private ExternalUrl externalUrls;
private String href;
private String id;
private Image[] images;
private String name;
private String releaseDate;
private ReleaseDatePrecision releaseDatePrecision;
private int totalTracks;
private ModelObjectType type;
private String uri;
/**
* Set the type of the album to be built.
*
* @param albumType The {@link AlbumType}.
* @return A {@link Album.Builder}.
*/
public Builder setAlbumType(AlbumType albumType) {
this.albumType = albumType;
return this;
}
/**
* Set the artists of the album to be built.
*
* @param artists {@link ArtistSimplified} objects.
* @return A {@link Album.Builder}.
*/
public Builder setArtists(ArtistSimplified... artists) {
this.artists = artists;
return this;
}
/**
* Set the available markets of the album to be built.
*
* @param availableMarkets
* ISO 3166-1 alpha-2 country codes.
* @return A {@link Album.Builder}.
*/
public Builder setAvailableMarkets(CountryCode... availableMarkets) {
this.availableMarkets = availableMarkets;
return this;
}
/**
* Set external URLs of the album to be built.
*
* @param externalUrls {@link ExternalUrl} object.
* @return A {@link Album.Builder}.
*/
public Builder setExternalUrls(ExternalUrl externalUrls) {
this.externalUrls = externalUrls;
return this;
}
/**
* Set href of Spotify Web API endpoint of the album to be built.
*
* @param href Spotify Web API endpoint URL.
* @return A {@link Album.Builder}.
*/
public Builder setHref(String href) {
this.href = href;
return this;
}
/**
* Set album ID of the album to be built.
*
* @param id Spotify album ID.
* @return A {@link Album.Builder}.
*/
public Builder setId(String id) {
this.id = id;
return this;
}
/**
* Set the cover art in different sizes of the album to be built.
*
* @param images {@link Image} objects.
* @return A {@link Album.Builder}.
*/
public Builder setImages(Image... images) {
this.images = images;
return this;
}
/**
* Set the name of the album to be built.
*
* @param name The album name.
* @return A {@link Album.Builder}.
*/
public Builder setName(String name) {
this.name = name;
return this;
}
/**
* Set the release date of the album to be built.
*
* @param releaseDate The release date of the album.
* @return A {@link Album.Builder}.
*/
public Builder setReleaseDate(String releaseDate) {
this.releaseDate = releaseDate;
return this;
}
/**
* Set the release date precision of the album to be built.
*
* @param releaseDatePrecision The {@link ReleaseDatePrecision} of the album.
* @return A {@link Album.Builder}.
*/
public Builder setReleaseDatePrecision(ReleaseDatePrecision releaseDatePrecision) {
this.releaseDatePrecision = releaseDatePrecision;
return this;
}
/**
* Set the number of total tracks of the album to be built.
*
* @param totalTracks The number of total tracks of the album.
* @return A {@link Album.Builder}.
*/
public Builder setTotalTracks(int totalTracks) {
this.totalTracks = totalTracks;
return this;
}
/**
* Set the type of the model object. In this case "album".
*
* @param type The {@link ModelObjectType}.
* @return A {@link Album.Builder}.
*/
public Builder setType(ModelObjectType type) {
this.type = type;
return this;
}
/**
* Set the Spotify album URI of the album to be built.
*
* @param uri
* Spotify album URI.
* @return A {@link Album.Builder}.
*/
public Builder setUri(String uri) {
this.uri = uri;
return this;
}
@Override
public AlbumSimplifiedSpecial build() {
return new AlbumSimplifiedSpecial(this);
}
}
/**
* JsonUtil class for building {@link AlbumSimplifiedSpecial} instances.
*/
public static final class JsonUtil extends AbstractModelObject.JsonUtil {
public AlbumSimplifiedSpecial createModelObject(JsonObject jsonObject) {
if (jsonObject == null || jsonObject.isJsonNull()) {
return null;
}
return new AlbumSimplifiedSpecial.Builder()
.setAlbumType(
hasAndNotNull(jsonObject, "album_type")
? AlbumType.keyOf(
jsonObject.get("album_type").getAsString().toLowerCase())
: null)
.setArtists(
hasAndNotNull(jsonObject, "artists")
? new ArtistSimplified.JsonUtil().createModelObjectArray(
jsonObject.getAsJsonArray("artists"))
: null)
.setAvailableMarkets(
hasAndNotNull(jsonObject, "available_markets")
? new Gson().fromJson(
jsonObject.get("available_markets"), CountryCode[].class)
: null)
.setExternalUrls(
hasAndNotNull(jsonObject, "external_urls")
? new ExternalUrl.JsonUtil().createModelObject(
jsonObject.getAsJsonObject("external_urls"))
: 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)
.setReleaseDate(
hasAndNotNull(jsonObject, "release_date")
? jsonObject.get("release_date").getAsString()
: null)
.setReleaseDatePrecision(
hasAndNotNull(jsonObject, "release_date_precision")
? ReleaseDatePrecision.keyOf(
jsonObject.get("release_date_precision").getAsString().toLowerCase())
: null)
.setTotalTracks(
hasAndNotNull(jsonObject, "total_tracks")
? jsonObject.get("total_tracks").getAsInt()
: null)
.setType(
hasAndNotNull(jsonObject, "type")
? ModelObjectType.keyOf(
jsonObject.get("type").getAsString().toLowerCase())
: null)
.setUri(
hasAndNotNull(jsonObject, "uri")
? jsonObject.get("uri").getAsString()
: null)
.build();
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy