Package edu.cnm.deepdive.scalescroller.model.entity

Enum Mode

  • All Implemented Interfaces:
    Serializable, Comparable<Mode>
    public enum Mode
extends Enum<Mode>
    Enumerates the different modes available for use in ScaleScroller. Each enumerated type includes notes, measured in half-steps from the tonic, and a difficulty rating to help structure gameplay.

    • Enum Constant Detail

      • MAJOR

        public static final Mode MAJOR

      • NATURAL_MINOR

        public static final Mode NATURAL_MINOR

      • HARMONIC_MINOR

        public static final Mode HARMONIC_MINOR

      • MELODIC_MINOR

        public static final Mode MELODIC_MINOR

    • Method Detail

      • values

        public static Mode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Mode c : Mode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Mode valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
        NullPointerException - if the argument is null

      • getDifficulty

        public abstract Map<Note,​Integer> getDifficulty()
        Returns a map of tonic notes to integer difficulties.
        Returns:
        A map of tonics to difficulties.

      • getSteps

        public int[] getSteps()
        Returns the notes in the scale (in terms of half-steps above tonic).
        Returns:
        The notes in the scale.

      • toString

        @NonNull
public String toString()
        Overrides the toString method for a more user-readable scale mode representation.
        Overrides:
        toString in class Enum<Mode>
        Returns:
        A string of the mode.