Module qilletni.api

Package dev.qilletni.api.lang.types.song

Enum Class SongDefinition

java.lang.Object

java.lang.Enum<SongDefinition>

dev.qilletni.api.lang.types.song.SongDefinition

All Implemented Interfaces:

Serializable, Comparable<SongDefinition>, Constable

public enum SongDefinition
extends Enum<SongDefinition>

Specifies how a song is defined via its syntax or internally.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
PREPOPULATED	The song was defined with data already from service provider data, likely coming from a direct API call.
TITLE_ARTIST	The song was defined with a title and an artist, e.g.
URL	The song was defined with a URL or ID pointing to it on the service provider.

Method Summary

Modifier and Type	Method	Description
static SongDefinition	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SongDefinition[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PREPOPULATED

public static final SongDefinition PREPOPULATED

The song was defined with data already from service provider data, likely coming from a direct API call.

URL

public static final SongDefinition URL

The song was defined with a URL or ID pointing to it on the service provider.

TITLE_ARTIST

public static final SongDefinition TITLE_ARTIST

The song was defined with a title and an artist, e.g. "My Song" by "Artist Name"

Method Details

values

public static SongDefinition[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SongDefinition valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null