sky.monome.event.sequencer
Enum NotePlayerListener.PlayerMode

java.lang.Object
  extended by java.lang.Enum<NotePlayerListener.PlayerMode>
      extended by sky.monome.event.sequencer.NotePlayerListener.PlayerMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<NotePlayerListener.PlayerMode>
Enclosing class:
NotePlayerListener<S extends Sequencer<S,B>,B extends ButtonManager<B>>

public static enum NotePlayerListener.PlayerMode
extends java.lang.Enum<NotePlayerListener.PlayerMode>

Player mode used by note player listeners.


Enum Constant Summary
PLAY_WITH_NOTE_NUMBER_IN_STEP
          Denotes the player mode that takes the number of the currently active note rank in the currently active step to choose the note to play in the scale.
PLAY_WITH_STEP_NUMBER
          Denotes the player mode that takes the number of the currently active step to choose the note to play in the scale.
 
Method Summary
abstract  int getMaximumValueForPropertyOfInterest(Sequencer<?,?> sequencer)
          Returns the maximum value for the property of interest in the specified sequencer.
abstract  int getPropertyOfInterest(SequencerEvent<?,?> sequencerEvent)
          Returns the property of interest in the specified sequencer event.
static NotePlayerListener.PlayerMode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static NotePlayerListener.PlayerMode[] 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

PLAY_WITH_STEP_NUMBER

public static final NotePlayerListener.PlayerMode PLAY_WITH_STEP_NUMBER
Denotes the player mode that takes the number of the currently active step to choose the note to play in the scale.


PLAY_WITH_NOTE_NUMBER_IN_STEP

public static final NotePlayerListener.PlayerMode PLAY_WITH_NOTE_NUMBER_IN_STEP
Denotes the player mode that takes the number of the currently active note rank in the currently active step to choose the note to play in the scale.

Method Detail

values

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

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

valueOf

public static NotePlayerListener.PlayerMode 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

getPropertyOfInterest

public abstract int getPropertyOfInterest(SequencerEvent<?,?> sequencerEvent)
Returns the property of interest in the specified sequencer event.

Parameters:
sequencerEvent - Sequencer event to extract the property of interest.
Returns:
The property of interest in the specified sequencer event.
Since:
SkyMonome v1.2

getMaximumValueForPropertyOfInterest

public abstract int getMaximumValueForPropertyOfInterest(Sequencer<?,?> sequencer)
Returns the maximum value for the property of interest in the specified sequencer.

Parameters:
sequencer - Sequencer to extract the maximum value for the property of interest.
Returns:
The maximum value for the property of interest in the specified sequencer.
Since:
SkyMonome v1.2