sky.monome.util.scale
Enum MidiNote.Note

java.lang.Object
  java.lang.Enum<MidiNote.Note>
      sky.monome.util.scale.MidiNote.Note

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MidiNote.Note>

Enclosing class:

MidiNote

public static enum MidiNote.Note
extends java.lang.Enum<MidiNote.Note>

Octave note.

Since:

SkyMonome v1.1

Author:

PJ Skyman

Enum Constant Summary

A
Denotes a A note.

A_FLAT
Denotes a Ab note.

A_SHARP
Denotes a A# note.

B
Denotes a B note.

B_FLAT
Denotes a Bb note.

C
Denotes a C note.

C_SHARP
Denotes a C# note.

D
Denotes a D note.

D_FLAT
Denotes a Db note.

D_SHARP
Denotes a D# note.

E
Denotes a E note.

E_FLAT
Denotes a Eb note.

F
Denotes a F note.

F_SHARP
Denotes a F# note.

G
Denotes a G note.

G_FLAT
Denotes a Gb note.

G_SHARP
Denotes a G# note.

NaN
Denotes that this octave note is not a note (Not a Note).

Method Summary

MidiNote.Note	getNextSemitone() Returns the octave note which represents the next semitone after this octave note.
MidiNote.Note	getNextTone() Returns the octave note which represents the next tone after this octave note.
int	getNumberInOctave() Returns the rank in the octave of this octave note.
MidiNote.Note	getOffsettedNote(int offset) Returns the octave note which is the result of the specified offset applied on this octave note.
MidiNote.Note	getPreviousSemitone() Returns the octave note which represents the previous semitone before this octave note.
MidiNote.Note	getPreviousTone() Returns the octave note which represents the previous tone before this octave note.
static MidiNote.Note	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MidiNote.Note[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NaN

public static final MidiNote.Note NaN

Denotes that this octave note is not a note (Not a Note).

C

public static final MidiNote.Note C

Denotes a C note.

C_SHARP

public static final MidiNote.Note C_SHARP

Denotes a C# note.

D_FLAT

public static final MidiNote.Note D_FLAT

Denotes a Db note.

D

public static final MidiNote.Note D

Denotes a D note.

D_SHARP

public static final MidiNote.Note D_SHARP

Denotes a D# note.

E_FLAT

public static final MidiNote.Note E_FLAT

Denotes a Eb note.

E

public static final MidiNote.Note E

Denotes a E note.

F

public static final MidiNote.Note F

Denotes a F note.

F_SHARP

public static final MidiNote.Note F_SHARP

Denotes a F# note.

G_FLAT

public static final MidiNote.Note G_FLAT

Denotes a Gb note.

G

public static final MidiNote.Note G

Denotes a G note.

G_SHARP

public static final MidiNote.Note G_SHARP

Denotes a G# note.

A_FLAT

public static final MidiNote.Note A_FLAT

Denotes a Ab note.

A

public static final MidiNote.Note A

Denotes a A note.

A_SHARP

public static final MidiNote.Note A_SHARP

Denotes a A# note.

B_FLAT

public static final MidiNote.Note B_FLAT

Denotes a Bb note.

B

public static final MidiNote.Note B

Denotes a B note.

Method Detail

values

public static MidiNote.Note[] 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 (MidiNote.Note c : MidiNote.Note.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MidiNote.Note valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getOffsettedNote

public MidiNote.Note getOffsettedNote(int offset)

Returns the octave note which is the result of the specified offset applied on this octave note.

Parameters:

offset - Offset to apply to this octave note.

Returns:

The octave note which is the result of the specified offset applied on this octave note.

getNumberInOctave

public int getNumberInOctave()

Returns the rank in the octave of this octave note.

Returns:

The rank in the octave of this octave note.

getNextSemitone

public MidiNote.Note getNextSemitone()

Returns the octave note which represents the next semitone after this octave note.

Returns:

The octave note which represents the next semitone after this octave note.

getPreviousSemitone

public MidiNote.Note getPreviousSemitone()

Returns the octave note which represents the previous semitone before this octave note.

Returns:

The octave note which represents the previous semitone before this octave note.

getNextTone

public MidiNote.Note getNextTone()

Returns the octave note which represents the next tone after this octave note.

Returns:

The octave note which represents the next tone after this octave note.

getPreviousTone

public MidiNote.Note getPreviousTone()

Returns the octave note which represents the previous tone before this octave note.

Returns:

The octave note which represents the previous tone before this octave note.