heurgame.logging
Interface LogWriter

All Known Implementing Classes:

LogBox

public interface LogWriter

Author:

David Kaplin Log writers report information to the logs. In this system the Log writers are passive. Over time the log that they registered with will check it for updates.

Method Summary

java.util.List	getEntries() This is the normal method for adding information to the log.
java.lang.String	getLogName() Usually a particular LogWriter is going to send more than one message to the log during the life of a program.
java.util.List	urgentEntries() Normally logs are stored in a FIFO manner.

Method Detail

getLogName

public java.lang.String getLogName()

Usually a particular LogWriter is going to send more than one message to the log during the life of a program. To avoid constantly sending the sender's name during updates a LogWriter should identify itself through this message.

Returns:

Descriptive name of the reporting component.

getEntries

public java.util.List getEntries()

This is the normal method for adding information to the log.

urgentEntries

public java.util.List urgentEntries()

Normally logs are stored in a FIFO manner. Using this method will give your message the opportunity to reach the highest point in the log.

Returns:

A List of urgent entires for the log