Package se.michaelthelin.spotify.enums

Enum Class Modality

java.lang.Object

java.lang.Enum<Modality>

se.michaelthelin.spotify.enums.Modality

All Implemented Interfaces:

Serializable, Comparable<Modality>, java.lang.constant.Constable

public enum Modality
extends Enum<Modality>

An enumeration with the two modality types.

See Also:

• Wikipedia: Mode (Music)

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
MAJOR	Major modality (mode = 1).
MINOR	Minor modality (mode = 0).

Field Summary

Fields

Modifier and Type	Field	Description
final int	mode	The numeric mode value (0 for minor, 1 for major).

Method Summary

Modifier and Type	Method	Description
int	getType()	Get the Modality type as a string.
static Modality	keyOf(int mode)	Get the Modality associated with the given mode value.
static Modality	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Modality[]	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

MAJOR

public static final Modality MAJOR

Major modality (mode = 1).

MINOR

public static final Modality MINOR

Minor modality (mode = 0).

Field Details

mode

public final int mode

The numeric mode value (0 for minor, 1 for major).

Method Details

values

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

keyOf

public static Modality keyOf(int mode)

Get the Modality associated with the given mode value.

Parameters:

mode - the mode value (0 for minor, 1 for major)

Returns:

the corresponding Modality, or null if not found

getType

public int getType()

Get the Modality type as a string.

Returns:

Modality type as a string.