Module qilletni.api

Package dev.qilletni.api.music

Interface MusicCache

public interface MusicCache

An interface to efficiently retrieve music data that can be cached, usually in a database. If the cache misses, MusicFetcher is used, and the cache is updated automatically.

Method Summary

Modifier and Type	Method	Description
Optional<Album>	getAlbum(String name, String artist)	Gets an Album from a given name and artist.
Optional<Album>	getAlbumById(String id)	Gets an Album from a given ID.
List<Track>	getAlbumTracks(Album album)	Gets all tracks from a given Album.
Optional<Artist>	getArtistById(String id)	Gets an Artist from a given ID.
Optional<Artist>	getArtistByName(String name)	Gets an Artist from a given name.
String	getIdFromString(String idOrUrl)	Takes in a URL or an ID and returns the ID.
Optional<Playlist>	getPlaylist(String name, String author)	Gets a Playlist from a given name and author.
Optional<Playlist>	getPlaylistById(String id)	Gets a Playlist from a given ID.
List<Track>	getPlaylistTracks(Playlist playlist)	Gets all tracks from a given Playlist.
Optional<Track>	getTrack(String name, String artist)	Gets a Track from a given name and artist.
Optional<Track>	getTrackById(String id)	Gets a Track from a given ID, specific to the service provider implementation.
List<Track>	getTracks(List<MusicFetcher.TrackNameArtist> tracks)	Gets multiple Tracks from a given list of MusicFetcher.TrackNameArtists.
List<Track>	getTracksById(List<String> trackIds)	Gets multiple Tracks from a given list of IDs.

Method Details

getTrack

Optional<Track> getTrack(String name,
 String artist)

Gets a Track from a given name and artist. If multiple tracks are found with the name/artist combination, it is up to the implementation to decide what to pick.

Parameters:

name - The name of the track, not including the artist name

artist - The name of the artist

Returns:

The track with the given name and artist, if any

getTrackById

Optional<Track> getTrackById(String id)

Gets a Track from a given ID, specific to the service provider implementation.

Parameters:

id - The ID of the track. This is in different formats for each service provider implementation.

Returns:

The track with the given ID, if any

getTracks

List<Track> getTracks(List<MusicFetcher.TrackNameArtist> tracks)

Gets multiple Tracks from a given list of MusicFetcher.TrackNameArtists. This effectively performs what getTrack(String, String) does, but batched for multiple tracks at once.

Parameters:

tracks - The tracks to look up

Returns:

The list of tracks that were found, in the same order as the given list of tracks. If a track isn't found, it is skipped

getTracksById

List<Track> getTracksById(List<String> trackIds)

Gets multiple Tracks from a given list of IDs. This effectively performs what getTrackById(String) does, but batched for multiple tracks at once. The IDs are in different formats for each service provider.

Parameters:

trackIds - The IDs of the tracks to look up

Returns:

The list of tracks that were found, in the same order as the given list of track IDs. If a track isn't found, it is skipped.

getPlaylist

Optional<Playlist> getPlaylist(String name,
 String author)

Gets a Playlist from a given name and author. If multiple playlists are found with the name/author combination, it is up to the implementation to decide what to pick. If multiple playlists are found with the same name, it is up to the implementation to decide what to pick.

Parameters:

name - The name of the playlist

author - The name of the artist

Returns:

The playlist with the given name and author, if any

getPlaylistById

Optional<Playlist> getPlaylistById(String id)

Gets a Playlist from a given ID. This is in different formats for each service provider implementation.

Parameters:

id - The ID of the playlist. This is in different formats for each service provider implementation

Returns:

The playlist with the given ID, if any

getAlbum

Optional<Album> getAlbum(String name,
 String artist)

Gets an Album from a given name and artist. If multiple albums are found with the name/artist combination, it is up to the implementation to decide what to pick. If multiple albums are found with the same name, it is up to the implementation to decide what to pick.

Parameters:

name - The name of the album, not including the artist name

artist - The name of the artist

Returns:

The album with the given name and artist, if any

getAlbumById

Optional<Album> getAlbumById(String id)

Gets an Album from a given ID. This is in different formats for each service provider implementation.

Parameters:

id - The ID of the album. This is in different formats for each service provider implementation

Returns:

The album with the given ID, if any

getAlbumTracks

List<Track> getAlbumTracks(Album album)

Gets all tracks from a given Album.

Parameters:

album - The album to get tracks from

Returns:

A list of all tracks in the album, in the order they appear in the album.

getPlaylistTracks

List<Track> getPlaylistTracks(Playlist playlist)

Gets all tracks from a given Playlist.

Parameters:

playlist - The playlist to get tracks from

Returns:

A list of all tracks in the playlist, in the order they appear in the playlist

getArtistById

Optional<Artist> getArtistById(String id)

Gets an Artist from a given ID. This is in different formats for each service provider implementation.

Parameters:

id - The ID of the artist. This is in different formats for each service provider implementation.

Returns:

The artist with the given ID, if any

getArtistByName

Optional<Artist> getArtistByName(String name)

Gets an Artist from a given name. If multiple artists are found with the same name, it is up to the implementation to decide what to pick.

Parameters:

name - The full name of the artist to look up

Returns:

The artist with the given name, if any

getIdFromString

String getIdFromString(String idOrUrl)

Takes in a URL or an ID and returns the ID.

Parameters:

idOrUrl - The URL or ID

Returns:

The ID