Module qilletni.api

Package dev.qilletni.api.lang.types.weights

Enum Class WeightTrackType

java.lang.Object

java.lang.Enum<WeightTrackType>

dev.qilletni.api.lang.types.weights.WeightTrackType

All Implemented Interfaces:

Serializable, Comparable<WeightTrackType>, Constable

public enum WeightTrackType
extends Enum<WeightTrackType>

The source of a WeightEntry.

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
COLLECTION	The weight entry is a collection, and when the weight is chosen, it will follow the ordering rules of the collection.
FUNCTION	The weight entry is a function, and will be evaluated when the weight entry is picked.
LIST	The weight entry is a list of tracks, and will choose a random track from the list when the weight entry is picked.
PLAYLIST	The weight entry is a Playlist, and will choose a random track from the playlist when the weight entry is picked.
SINGLE_TRACK	The weight entry is a single track.
WEIGHTS	The weight entry is another set of weights, allowing for nested weights.

Method Summary

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

SINGLE_TRACK

public static final WeightTrackType SINGLE_TRACK

The weight entry is a single track.

LIST

public static final WeightTrackType LIST

The weight entry is a list of tracks, and will choose a random track from the list when the weight entry is picked.

COLLECTION

public static final WeightTrackType COLLECTION

The weight entry is a collection, and when the weight is chosen, it will follow the ordering rules of the collection. See the Collection Weights docs for more info.

WEIGHTS

public static final WeightTrackType WEIGHTS

The weight entry is another set of weights, allowing for nested weights. See the Nested Weights docs for more info.

PLAYLIST

public static final WeightTrackType PLAYLIST

The weight entry is a Playlist, and will choose a random track from the playlist when the weight entry is picked.

FUNCTION

public static final WeightTrackType FUNCTION

The weight entry is a function, and will be evaluated when the weight entry is picked. The function should always supply a track. See the Function Call Weights docs for more info.

Method Details

values

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