Module qilletni.api

Package dev.qilletni.api.lang.types

Interface SongType

All Superinterfaces:

AnyType, QilletniType

public non-sealed interface SongType
extends AnyType

Represents a song type in Qilletni. This may be created by the "Song Name" by "Artist Name" expression syntax. The internal service provider's type is dynamic, changing how the data is fetched when the service provider is changed.

Method Summary

Modifier and Type	Method	Description
AlbumType	getAlbum()	Retrieves the album this song is on.
EntityType	getArtist(EntityDefinitionManager entityDefinitionManager)	Retrieves the artist as an Artist EntityType for the given entity definition manager.
ListType	getArtists(EntityDefinitionManager entityDefinitionManager)	Retrieves a list of artists as a ListType, resolved using the given EntityDefinitionManager.
SongDefinition	getSongDefinition()	Retrieves the current song definition associated with the implementing object.
String	getSuppliedArtist()	Retrieves the supplied artist name for the album, if the artist was provided.
String	getSuppliedTitle()	Retrieves the supplied title for the album, if the title was provided.
String	getSuppliedUrl()	Retrieves the supplied URL for the song, if the URL was provided.
Track	getTrack()	Retrieves the current track instance associated with the implementing object for the current service provider.
boolean	isSpotifyDataPopulated()	Checks whether service provider data has been successfully populated for the current instance.
void	populateSpotifyData(Track track)	Populates the music provider instance of the Track stored in the SongType.
void	setSongDefinition(SongDefinition songDefinition)	Sets the song definition for the implementing object.

Methods inherited from interface dev.qilletni.api.lang.types.QilletniType

getTypeClass, minusOperator, minusOperatorInPlace, plusOperator, plusOperatorInPlace, qilletniEquals, stringValue, typeName

Method Details

getSongDefinition

SongDefinition getSongDefinition()

Retrieves the current song definition associated with the implementing object. The song definition determines the method by which song data is classified or resolved, such as by URL, title and artist, or prepopulated data.

Returns:

The SongDefinition representing the current song classification method

setSongDefinition

void setSongDefinition(SongDefinition songDefinition)

Sets the song definition for the implementing object. The song definition determines how the song data is classified or resolved, such as by URL, title and artist, or prepopulated data.

Parameters:

songDefinition - The SongDefinition representing the classification method to be set

getSuppliedUrl

String getSuppliedUrl()

Retrieves the supplied URL for the song, if the URL was provided.

Returns:

A string representing the user-supplied URL

getSuppliedTitle

String getSuppliedTitle()

Retrieves the supplied title for the album, if the title was provided.

Returns:

A string representing the user-supplied title

getSuppliedArtist

String getSuppliedArtist()

Retrieves the supplied artist name for the album, if the artist was provided.

Returns:

A string representing the user-supplied artist

getAlbum

AlbumType getAlbum()

Retrieves the album this song is on.

Returns:

The album this song is on

getArtist

EntityType getArtist(EntityDefinitionManager entityDefinitionManager)

Retrieves the artist as an Artist EntityType for the given entity definition manager. The artist entity is resolved using the provided EntityDefinitionManager.

Parameters:

entityDefinitionManager - The manager responsible for defining and looking up entity definitions

Returns:

The EntityType representing the artist resolved through the entity definition manager

getArtists

ListType getArtists(EntityDefinitionManager entityDefinitionManager)

Retrieves a list of artists as a ListType, resolved using the given EntityDefinitionManager.

Parameters:

entityDefinitionManager - The manager responsible for defining and resolving entity definitions

Returns:

A ListType representing the artists resolved through the entity definition manager

getTrack

Track getTrack()

Retrieves the current track instance associated with the implementing object for the current service provider.

Returns:

An instance of the Track backing the song

isSpotifyDataPopulated

boolean isSpotifyDataPopulated()

Checks whether service provider data has been successfully populated for the current instance.

Returns:

true if service provider data is populated, false otherwise

populateSpotifyData

void populateSpotifyData(Track track)

Populates the music provider instance of the Track stored in the SongType. This must be called before invoking methods that deal with the actual contents of the Track, such as getting artists.

Parameters:

track - The Track instance to populate