Module qilletni.api

Package dev.qilletni.api.music

Interface MusicPopulator

public interface MusicPopulator

Populates music types with data from the MusicCache, used before accessing the data.

Method Summary

Modifier and Type	Method	Description
AlbumType	initiallyPopulateAlbum(AlbumType albumType)	If eager loading is enabled, the given album is populated via populateAlbum(AlbumType).
CollectionType	initiallyPopulateCollection(CollectionType collectionType)	If eager loading is enabled, the given album is populated via populateCollection(CollectionType).
SongType	initiallyPopulateSong(SongType songType)	If eager loading is enabled, the given song is populated via populateSong(SongType).
void	populateAlbum(AlbumType albumType)	Takes an AlbumType and collects all relevant data via MusicCache and populates the type with SongType.populateSpotifyData(Track).
void	populateCollection(CollectionType collectionType)	Takes an CollectionType and collects all relevant data via MusicCache and populates the type with CollectionType.populateSpotifyData(Playlist).
void	populateSong(SongType songType)	Takes a SongType and collects all relevant data via MusicCache and populates the type with SongType.populateSpotifyData(Track).

Method Details

initiallyPopulateSong

SongType initiallyPopulateSong(SongType songType)

If eager loading is enabled, the given song is populated via populateSong(SongType). Otherwise, nothing occurs. TODO: Make this into some kind of factory for SongTypes?

Parameters:

songType - The song to populate

Returns:

The supplied SongType

populateSong

void populateSong(SongType songType)

Takes a SongType and collects all relevant data via MusicCache and populates the type with SongType.populateSpotifyData(Track).

Parameters:

songType - The song to populate

initiallyPopulateAlbum

AlbumType initiallyPopulateAlbum(AlbumType albumType)

If eager loading is enabled, the given album is populated via populateAlbum(AlbumType). Otherwise, nothing occurs. TODO: Make this into some kind of factory for AlbumTypes?

Parameters:

albumType - The album to populate

Returns:

The supplied AlbumType

populateAlbum

void populateAlbum(AlbumType albumType)

Takes an AlbumType and collects all relevant data via MusicCache and populates the type with SongType.populateSpotifyData(Track).

Parameters:

albumType - The album to populate

initiallyPopulateCollection

CollectionType initiallyPopulateCollection(CollectionType collectionType)

If eager loading is enabled, the given album is populated via populateCollection(CollectionType). Otherwise, nothing occurs. TODO: Make this into some kind of factory for CollectionTypes?

Parameters:

collectionType - The album to populate

Returns:

The supplied AlbumType

populateCollection

void populateCollection(CollectionType collectionType)

Takes an CollectionType and collects all relevant data via MusicCache and populates the type with CollectionType.populateSpotifyData(Playlist).

Parameters:

collectionType - The collection to populate