net.bjoernpetersen.musicbot.api.player.PlayerState.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of musicbot Show documentation

Core library of MusicBot, which plays music from various providers.

There is a newer version: 0.25.0

package net.bjoernpetersen.musicbot.api.player

/**
 * Represents the state of the player. All possible implementations can be found in this module.
 */
sealed class PlayerState {

    /**
     * A simple string representation of this state. Can be play, pause, stop or error.
     */
    abstract val name: String
    /**
     * The currently active [SongEntry].
     */
    abstract val entry: SongEntry?

    /**
     * Convenience method to determine whether the current state has a song (entry != null).
     */
    fun hasSong() = entry != null

    override fun equals(other: Any?): Boolean {
        if (this === other) return true
        if (javaClass != other?.javaClass) return false

        other as PlayerState

        if (entry != other.entry) return false

        return true
    }

    override fun hashCode(): Int {
        return entry?.hashCode() ?: 0
    }
}

/**
 * The player is currently active and is playing the song from [entry].
 */
data class PlayState(override val entry: SongEntry) : PlayerState() {

    override val name = "play"

    /**
     * Creates a [PauseState] with the same entry.
     */
    fun pause() = PauseState(entry)
}

/**
 * The player is currently inactive, but has an active [entry].
 */
data class PauseState(override val entry: SongEntry) : PlayerState() {

    override val name = "pause"

    /**
     * Creates a [PlayState] with the same entry.
     */
    fun play() = PlayState(entry)
}

/**
 * The player is currently inactive and does not have a song to resume.
 */
object StopState : PlayerState() {

    override val name = "stop"
    override val entry: SongEntry? = null
    override fun toString(): String = "StopState"
}

/**
 * The player is currently inactive because of an error.
 */
object ErrorState : PlayerState() {

    override val name = "error"
    override val entry: SongEntry? = null
    override fun toString(): String = "ErrorState"
}