net.kreatious.pianoleopard.history

Class History

java.lang.Object

net.kreatious.pianoleopard.history.History

public class History
extends Object

Provides a history of user events.

Author:

Jay-R Studer

Method Summary

Modifier and Type	Method and Description
static History	create(File log, OutputModel outputModel, InputModel inputModel) Creates a new History that manages historical events generated by the user.
Void	startReading(HistoryVisitor visitor) Starts parsing the log file with the specified visitor, if the log file exists.
void	stopReading(HistoryVisitor visitor) Stops reading the log file with the specified visitor.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static History create(File log,
                             OutputModel outputModel,
                             InputModel inputModel)

Creates a new History that manages historical events generated by the user.

Parameters:

log - the log file to read and write from.

outputModel - the OutputModel to listen to

inputModel - the InputModel to listen to

Returns:

a new functional History object if the log file can be written to, otherwise a new History object that does nothing.

startReading

public Void startReading(HistoryVisitor visitor)
                  throws IOException

Starts parsing the log file with the specified visitor, if the log file exists.

This method blocks until the log file is completely parsed, during which time visitor methods are called from the context of the current thread. After this method has returned, the visitor's methods will be called from various threads. It is guaranteed that two visitor's methods will not be concurrently executed.

If the log file is unavailable, this method returns immediately and no methods on the visitor will be called.

Parameters:

visitor - the visitor to register

Returns:

nothing. Used to cause Java to select the callable overload when used in a lambda expression.

Throws:

IOException - if an I/O error occurs

stopReading

public void stopReading(HistoryVisitor visitor)

Stops reading the log file with the specified visitor.

Parameters:

visitor - the visitor to unregister