Package se.michaelthelin.spotify.model_objects.special

Class SearchResult

java.lang.Object

se.michaelthelin.spotify.model_objects.AbstractModelObject

se.michaelthelin.spotify.model_objects.special.SearchResult

All Implemented Interfaces:

Serializable, IModelObject, IArtistTrackModelObject, ISearchModelObject

public class SearchResult
extends AbstractModelObject
implements IArtistTrackModelObject, ISearchModelObject

Retrieve the searched-for items by building instances from this class. This objects contains for every type specified by the type parameter in the SearchItemRequest the searched-for items wrapped in a Paging object.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SearchResult.Builder	Builder class for building SearchResult instances.
static final class	SearchResult.JsonUtil	JsonUtil class for building SearchResult instances.

Nested classes/interfaces inherited from interface se.michaelthelin.spotify.model_objects.IModelObject

IModelObject.IJsonUtil<T>

Method Summary

Modifier and Type	Method	Description
SearchResult.Builder	builder()	Create a builder for building an instance of a model object.
Paging<AlbumSimplified>	getAlbums()	Get the album objects contained in the search result object.
Paging<Artist>	getArtists()	Get the artist objects contained in the search result object.
Paging<EpisodeSimplified>	getEpisodes()	Get the episode objects contained in the search result object.
Paging<PlaylistSimplified>	getPlaylists()	Get the playlist objects contained in the search result object.
Paging<ShowSimplified>	getShows()	Get the show objects contained in the search result object.
Paging<Track>	getTracks()	Get the track objects contained in the search result object.
String	toString()	Returns a String representation of this model object in the style:

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getAlbums

public Paging<AlbumSimplified> getAlbums()

Get the album objects contained in the search result object.
Note: The search result only contains album objects when the album parameter has been specified in the request.

Returns:

Albums from the search result.

getArtists

public Paging<Artist> getArtists()

Get the artist objects contained in the search result object.
Note: The search result only contains artist objects when the artist parameter has been specified in the request.

Returns:

Artists from the search result.

getEpisodes

public Paging<EpisodeSimplified> getEpisodes()

Get the episode objects contained in the search result object.
Note: The search result only contains episode objects when the episode parameter has been specified in the request.

Returns:

Episodes from the search result.

getPlaylists

public Paging<PlaylistSimplified> getPlaylists()

Get the playlist objects contained in the search result object.
Note: The search result only contains playlist objects when the playlist parameter has been specified in the request.

Returns:

Playlists from the search result.

getShows

public Paging<ShowSimplified> getShows()

Get the show objects contained in the search result object.
Note: The search result only contains show objects when the show parameter has been specified in the request.

Returns:

Shows from the search result.

getTracks

public Paging<Track> getTracks()

Get the track objects contained in the search result object.
Note: The search result only contains track objects when the track parameter has been specified in the request.

Returns:

Tracks from the search result.

toString

public String toString()

Description copied from class: AbstractModelObject

Returns a String representation of this model object in the style:

ModelObject(attr1=value1, attr2=value2, ...)

Specified by:

toString in class AbstractModelObject

builder

public SearchResult.Builder builder()

Description copied from interface: IModelObject

Create a builder for building an instance of a model object.
The type of the builder and its methods depend on its corresponding implementation.

Specified by:

builder in interface IModelObject

Returns:

A builder object.