net.kreatious.pianoleopard.history

Class HistoryVisitor

java.lang.Object

net.kreatious.pianoleopard.history.HistoryVisitor

public abstract class HistoryVisitor
extends Object

Visits the events performed historically by the user.

Methods are called from various threads, but are guaranteed to not be called concurrently.

Author:

Jay-R Studer

Constructor Summary

Constructors

Constructor and Description
HistoryVisitor()

Method Summary

Modifier and Type	Method and Description
void	onFile(byte[] hash, long time) Called when the user has opened a file.
void	onKey(byte status, byte data1, byte data2, long currentTime, long time) Called when the user has pressed a key in the past.
abstract void	onParsingComplete() Called after parsing is complete.
void	onStart(long time) Called when the user begins a practice session.

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryVisitor

public HistoryVisitor()

Method Detail

onStart

public void onStart(long time)

Called when the user begins a practice session. The file being practiced will be given by a previous call to onFile(byte[], long).

Parameters:

time - the epoch time in milliseconds the sequence was started at

onFile

public void onFile(byte[] hash,
                   long time)

Called when the user has opened a file.

Parameters:

hash - the SHA-256 hash code of the file that was opened

time - the epoch time in milliseconds the event was played at

onKey

public void onKey(byte status,
                  byte data1,
                  byte data2,
                  long currentTime,
                  long time)
           throws InvalidMidiDataException

Called when the user has pressed a key in the past.

Parameters:

status - the status byte of the message the user played

data1 - the first data byte of the message

data2 - the second data byte of the message

currentTime - the current song time in microseconds the message was played at

time - the epoch time in milliseconds the event was played at

Throws:

InvalidMidiDataException - if the message was invalid

onParsingComplete

public abstract void onParsingComplete()

Called after parsing is complete.

This method may be called multiple times, and is guaranteed to be called at least once if the log file is accessible. If notifications are no longer desired, then the visitor needs to be unregistered.

If the History class was unable to initialize logging, this method is never called.