Module qilletni.api

Package dev.qilletni.api.lang.types.collection

Enum Class CollectionDefinition

java.lang.Object

java.lang.Enum<CollectionDefinition>

dev.qilletni.api.lang.types.collection.CollectionDefinition

All Implemented Interfaces:

Serializable, Comparable<CollectionDefinition>, Constable

public enum CollectionDefinition
extends Enum<CollectionDefinition>

Specifies how an album 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
NAME_CREATOR	The collection was defined with a name and a creator's name, e.g.
PREPOPULATED	The collection was defined with data already from service provider data, likely coming from a direct API call.
SONG_LIST	The collection was defined as a list of songs, and not sourcing from any specific provider (the internal songs are though).
URL	The collection was defined with a URL pointing to it on the service provider.

Method Summary

Modifier and Type	Method	Description
static CollectionDefinition	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CollectionDefinition[]	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 CollectionDefinition PREPOPULATED

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

URL

public static final CollectionDefinition URL

The collection was defined with a URL pointing to it on the service provider.

NAME_CREATOR

public static final CollectionDefinition NAME_CREATOR

The collection was defined with a name and a creator's name, e.g. "Collection Name" collection by "Your Name".

SONG_LIST

public static final CollectionDefinition SONG_LIST

The collection was defined as a list of songs, and not sourcing from any specific provider (the internal songs are though).

Method Details

values

public static CollectionDefinition[] 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 CollectionDefinition 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