Module qilletni.api

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

Enum Class CollectionOrder

java.lang.Object

java.lang.Enum<CollectionOrder>

dev.qilletni.api.lang.types.collection.CollectionOrder

All Implemented Interfaces:

Serializable, Comparable<CollectionOrder>, Constable

public enum CollectionOrder
extends Enum<CollectionOrder>

A backing type for the order type on a collection, e.g. order[shuffle] or order[sequential]. This defines what order a collection should select songs from.

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
SEQUENTIAL	The collection will play songs in the order that it is defined.
SHUFFLE	The collection will select songs randomly.

Method Summary

Modifier and Type	Method	Description
static CollectionOrder	getFromString(String orderString)	Retrieves the CollectionOrder associated with the specified order string.
String	getOrderString()	Gets the user-input string of the order.
static CollectionOrder	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CollectionOrder[]	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

SHUFFLE

public static final CollectionOrder SHUFFLE

The collection will select songs randomly.

SEQUENTIAL

public static final CollectionOrder SEQUENTIAL

The collection will play songs in the order that it is defined.

Method Details

values

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

getOrderString

public String getOrderString()

Gets the user-input string of the order.

Returns:

The string definition of the order

getFromString

public static CollectionOrder getFromString(String orderString)

Retrieves the CollectionOrder associated with the specified order string.

Parameters:

orderString - The string representation of the collection order

Returns:

The CollectionOrder matching the specified string

Throws:

IllegalStateException - If the specified string does not match any defined order