pulsar

Class NoteListParserElement

java.lang.Object

pulsar.NoteListParserElement

Direct Known Subclasses:

PulsarMidiNoteListParsers.MetroNoteParserAllNoteOff, PulsarMidiNoteListParsers.MetroNoteParserAllSoundOff, PulsarMidiNoteListParsers.MetroNoteParserChannelPressure, PulsarMidiNoteListParsers.MetroNoteParserClock, PulsarMidiNoteListParsers.MetroNoteParserContinue, PulsarMidiNoteListParsers.MetroNoteParserControlBalance, PulsarMidiNoteListParsers.MetroNoteParserControlBankSelect, PulsarMidiNoteListParsers.MetroNoteParserControlBreathController, PulsarMidiNoteListParsers.MetroNoteParserControlChange, PulsarMidiNoteListParsers.MetroNoteParserControlDataDecrement, PulsarMidiNoteListParsers.MetroNoteParserControlDataEntryMsb, PulsarMidiNoteListParsers.MetroNoteParserControlDataIncrement, PulsarMidiNoteListParsers.MetroNoteParserControlEffect1, PulsarMidiNoteListParsers.MetroNoteParserControlEffect2, PulsarMidiNoteListParsers.MetroNoteParserControlEffect3, PulsarMidiNoteListParsers.MetroNoteParserControlEffect4, PulsarMidiNoteListParsers.MetroNoteParserControlEffect5, PulsarMidiNoteListParsers.MetroNoteParserControlEffectController1, PulsarMidiNoteListParsers.MetroNoteParserControlEffectController2, PulsarMidiNoteListParsers.MetroNoteParserControlExpression, PulsarMidiNoteListParsers.MetroNoteParserControlFootController, PulsarMidiNoteListParsers.MetroNoteParserControlGeneralPurpose01, PulsarMidiNoteListParsers.MetroNoteParserControlGeneralPurpose02, PulsarMidiNoteListParsers.MetroNoteParserControlGeneralPurpose03, PulsarMidiNoteListParsers.MetroNoteParserControlGeneralPurpose04, PulsarMidiNoteListParsers.MetroNoteParserControlHold2, PulsarMidiNoteListParsers.MetroNoteParserControlLegatoSwitch, PulsarMidiNoteListParsers.MetroNoteParserControlModulation, PulsarMidiNoteListParsers.MetroNoteParserControlNrpnLsb, PulsarMidiNoteListParsers.MetroNoteParserControlNrpnMsb, PulsarMidiNoteListParsers.MetroNoteParserControlPan, PulsarMidiNoteListParsers.MetroNoteParserControlPedalSwitch, PulsarMidiNoteListParsers.MetroNoteParserControlPortamento, PulsarMidiNoteListParsers.MetroNoteParserControlPortamentoSwitch, PulsarMidiNoteListParsers.MetroNoteParserControlPortamentoTime, PulsarMidiNoteListParsers.MetroNoteParserControlRpnLsb, PulsarMidiNoteListParsers.MetroNoteParserControlRpnMsb, PulsarMidiNoteListParsers.MetroNoteParserControlSostenutoSwitch, PulsarMidiNoteListParsers.MetroNoteParserControlSoundController1, PulsarMidiNoteListParsers.MetroNoteParserControlSoundController10, PulsarMidiNoteListParsers.MetroNoteParserControlSoundController2, PulsarMidiNoteListParsers.MetroNoteParserControlSoundController3, PulsarMidiNoteListParsers.MetroNoteParserControlSoundController4, PulsarMidiNoteListParsers.MetroNoteParserControlSoundController5, PulsarMidiNoteListParsers.MetroNoteParserControlSoundController6, PulsarMidiNoteListParsers.MetroNoteParserControlSoundController7, PulsarMidiNoteListParsers.MetroNoteParserControlSoundController8, PulsarMidiNoteListParsers.MetroNoteParserControlSoundController9, PulsarMidiNoteListParsers.MetroNoteParserControlSustainPedal, PulsarMidiNoteListParsers.MetroNoteParserControlVolume, PulsarMidiNoteListParsers.MetroNoteParserEndOfExclusive, PulsarMidiNoteListParsers.MetroNoteParserError, PulsarMidiNoteListParsers.MetroNoteParserKeyPressure, PulsarMidiNoteListParsers.MetroNoteParserLocalControls, PulsarMidiNoteListParsers.MetroNoteParserMonoModeOn, PulsarMidiNoteListParsers.MetroNoteParserNoteOff, PulsarMidiNoteListParsers.MetroNoteParserNoteOn, PulsarMidiNoteListParsers.MetroNoteParserOmniModeOff, PulsarMidiNoteListParsers.MetroNoteParserOmniModeOn, PulsarMidiNoteListParsers.MetroNoteParserPitchBend, PulsarMidiNoteListParsers.MetroNoteParserPolyModeOn, PulsarMidiNoteListParsers.MetroNoteParserProgramChange, PulsarMidiNoteListParsers.MetroNoteParserReset, PulsarMidiNoteListParsers.MetroNoteParserResetAllController, PulsarMidiNoteListParsers.MetroNoteParserSongPositionPointer, PulsarMidiNoteListParsers.MetroNoteParserSongSelect, PulsarMidiNoteListParsers.MetroNoteParserStart, PulsarMidiNoteListParsers.MetroNoteParserStop, PulsarSpecialNoteListParsers.NoteEventParser, PulsarSpecialNoteListParsers.VoidEventParser

public abstract class NoteListParserElement
extends java.lang.Object

An instance of NoteListParserElement is a representation of a type of notes on the note list. This defines how a note element to be parsed and to perform. See NoteListParser.

Author:

ats

Constructor Summary

Constructors

Constructor and Description
NoteListParserElement()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getLongDescription()
abstract gnu.mapping.Symbol	getLongName() Returns its long name of the target notes.
abstract java.util.List<NoteListParserElementParameter>	getParameters()
abstract java.lang.String	getShortDescription()
abstract gnu.mapping.Symbol	getShortName() Returns its short name of the target notes.
abstract <T> void	parseEvent(Metro metro, MetroTrack track, MetroBufferedMidiReceiver<T> buffer, NoteListMap map, MetroCollector<T> result) Parse the current note on the processing note list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NoteListParserElement

public NoteListParserElement()

Method Detail

getLongName

public abstract gnu.mapping.Symbol getLongName()

Returns its long name of the target notes. The name should only contain English words without abbreviation. The word separator must only be hyphens.

This name should be a valid scheme identifier.

Returns:

The note type name.

getShortName

public abstract gnu.mapping.Symbol getShortName()

Returns its short name of the target notes. The name should be equal or shorter than four characters. This short name is applied as an identifier in a parser object; this should also be unique.

This name should be a valid scheme identifier.

Returns:

The note type name in a short form.

getShortDescription

public abstract java.lang.String getShortDescription()

getLongDescription

public abstract java.lang.String getLongDescription()

getParameters

public abstract java.util.List<NoteListParserElementParameter> getParameters()

parseEvent

public abstract <T> void parseEvent(Metro metro,
                                    MetroTrack track,
                                    MetroBufferedMidiReceiver<T> buffer,
                                    NoteListMap map,
                                    MetroCollector<T> result)

Parse the current note on the processing note list. For further information, see

• NoteListParser#parseNote(Metro, MetroTrack, MetroEventBuffer, boolean, gnu.lists.AbstractSequence)
• NoteListParser#parseAll(Metro, MetroTrack, Collection, MetroBufferedMidiReceiver, boolean)

Parameters:

metro - The instance of the current Metro.

track - The instance of the current MetroTrack which generated the note.

buffer - The instance of the current MetroEventBuffer to output into as a result of the processing.

map - An instance of Map that contains the contents of Scheme's association list.

result - TODO

result - The result of the previous parser element.