net.kreatious.pianoleopard.midi.track

Class ParsedSequence

java.lang.Object

net.kreatious.pianoleopard.midi.track.ParsedSequence

public class ParsedSequence
extends Object

Represents a parsed MIDI sequence containing multiple parsed tracks

Author:

Jay-R Studer

Method Summary

Modifier and Type	Method and Description
static ParsedSequence	createEmpty() Returns an empty parsed sequence containing nothing.
Collection<ParsedTrack>	getActiveTracks() Gets the active tracks stored by this parsed MIDI sequence.
Optional<File>	getFile() Gets the file that this sequence was originally created from.
Collection<ParsedTrack>	getInactiveTracks() Gets the inactive tracks stored by this parsed MIDI sequence.
Sequence	getSequence() Gets the original MIDI sequence used to create this parsed MIDI sequence.
List<ParsedTrack>	getTracks() Gets all tracks stored by this parsed MIDI sequence.
static ParsedSequence	parseByTracks(Sequence sequence) Parses a MIDI sequence, arranging it by tracks
void	setFile(Optional<File> file) Sets the file that this sequence was originally created from.
void	setTrackActive(ParsedTrack track, boolean active) Sets the specified track as active.

Methods inherited from class java.lang.Object

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

Method Detail

getFile

public Optional<File> getFile()

Gets the file that this sequence was originally created from.

If the returned file is not empty, subsequent calls to this function are guaranteed to return the same value.

Returns:

An optional containing the original file this sequence was created with.

setFile

public void setFile(Optional<File> file)

Sets the file that this sequence was originally created from.

This setter may only be called once per sequence. Subsequent calls will throw an exception.

Parameters:

file - the file for this sequence

Throws:

IllegalStateException - if the file has already been set.

getTracks

public List<ParsedTrack> getTracks()

Gets all tracks stored by this parsed MIDI sequence.

Returns:

a read only view of all parsed tracks contained in this sequence

getActiveTracks

public Collection<ParsedTrack> getActiveTracks()

Gets the active tracks stored by this parsed MIDI sequence.

Active tracks are those selected by the user for practice.

Returns:

a read only unordered view of the active parsed tracks contained in this sequence

getInactiveTracks

public Collection<ParsedTrack> getInactiveTracks()

Gets the inactive tracks stored by this parsed MIDI sequence.

Inactive tracks are those not selected by the user for practice.

Returns:

a read only unordered view of the inactive parsed tracks contained in this sequence

setTrackActive

public void setTrackActive(ParsedTrack track,
                           boolean active)

Sets the specified track as active.

If the track is already active, no changes occur.

Parameters:

track - the parsed track in this sequence to modify

active - true if the track should be active, otherwise false

Throws:

IllegalArgumentException - if the track is not contained in this sequence

getSequence

public Sequence getSequence()

Gets the original MIDI sequence used to create this parsed MIDI sequence.

Returns:

the original MIDI Sequence

createEmpty

public static ParsedSequence createEmpty()

Returns an empty parsed sequence containing nothing.

Returns:

a new empty ParsedSequence

parseByTracks

public static ParsedSequence parseByTracks(Sequence sequence)

Parses a MIDI sequence, arranging it by tracks

Parameters:

sequence - the sequence to parse

Returns:

a new ParsedSequence