Module qilletni.api

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

Enum Class CollectionLimitUnit

java.lang.Object

java.lang.Enum<CollectionLimitUnit>

dev.qilletni.api.lang.types.collection.CollectionLimitUnit

All Implemented Interfaces:

Serializable, Comparable<CollectionLimitUnit>, Constable

public enum CollectionLimitUnit
extends Enum<CollectionLimitUnit>

The unit for a collection limit from CollectionLimit.

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
COUNT	A set number of songs are played from the collection.
HOUR	The collection is played until a set number of hours passes.
MINUTE	The collection is played until a set number of minutes passes.
SECOND	The collection is played until a set number of seconds passes.

Method Summary

Modifier and Type	Method	Description
static CollectionLimitUnit	fromText(String text)	Gets the CollectionLimitUnit from the given prefix.
TimeUnit	getTimeUnit()	Gets the Java TimeUnit the limit unit represents, or null if it's not applicable for the unit (is a COUNT).
String	getUnitText()	Returns the unit text representation of the collection limit unit.
static CollectionLimitUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CollectionLimitUnit[]	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

COUNT

public static final CollectionLimitUnit COUNT

A set number of songs are played from the collection.

SECOND

public static final CollectionLimitUnit SECOND

The collection is played until a set number of seconds passes.

MINUTE

public static final CollectionLimitUnit MINUTE

The collection is played until a set number of minutes passes.

HOUR

public static final CollectionLimitUnit HOUR

The collection is played until a set number of hours passes.

Method Details

values

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

getUnitText

public String getUnitText()

Returns the unit text representation of the collection limit unit. This value serves as a textual suffix or identifier (e.g., "s" for seconds, "m" for minutes) used in formatting and representations.

Returns:

the unit text associated with the collection limit unit

getTimeUnit

public TimeUnit getTimeUnit()

Gets the Java TimeUnit the limit unit represents, or null if it's not applicable for the unit (is a COUNT).

Returns:

The TimeUnit of the unit, if applicable

fromText

public static CollectionLimitUnit fromText(String text)

Gets the CollectionLimitUnit from the given prefix.

Parameters:

text - The prefix of the unit

Returns:

The found CollectionLimitUnit

Throws:

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