Module qilletni.api

Package dev.qilletni.api.music.orchestration

Interface CollectionState

public interface CollectionState

Holds any stateful information that a collection may need for selecting its next track.
This holds an index that is incremented when a track is chosen, used for when a collection is being selected from sequentially. This allows the first song to be chosen, then the second, third, etc.

Method Summary

Modifier and Type	Method	Description
int	getAndIncrementSequentialIndex()	Gets the index to choose a song by, and then increments it.
CollectionType	getCollection()	Retrieves the current collection associated with this state.
int	getSequentialIndex()	Gets the current index that is incremented by getAndIncrementSequentialIndex(), used for getting tracks in order.
List<Track>	getTracks()	Gets all the tracks the collection contains.
String	stringValue()	Returns a Qilletni-user-friendly string to display this state.

Method Details

getCollection

CollectionType getCollection()

Retrieves the current collection associated with this state.

Returns:

The CollectionType representing the current collection

getTracks

List<Track> getTracks()

Gets all the tracks the collection contains.

Returns:

All tracks the collection contains

getSequentialIndex

int getSequentialIndex()

Gets the current index that is incremented by getAndIncrementSequentialIndex(), used for getting tracks in order. This is essentially a "peek" of getAndIncrementSequentialIndex().

Returns:

Gets the index of the current track that should be chosen

getAndIncrementSequentialIndex

int getAndIncrementSequentialIndex()

Gets the index to choose a song by, and then increments it. If the new index goes past the length of the collection, it wraps back to 0.

Returns:

The index of the current track that should be chosen

stringValue

String stringValue()

Returns a Qilletni-user-friendly string to display this state.

Returns:

A string representation of this state