com.compomics.util.interfaces
Interface Logger

All Known Implementing Classes:
DefaultOutputLoggerImplementation, FileLoggerImplementation

public interface Logger

This interface describes the behaviour for a class that can log messages. The difference in logging between all the different methods is entirely up to the implementing class! (i.e.: there will be implementations that do not make a difference!)

Author:
Lennart Martens

Method Summary
 void logExceptionalEvent(String aMessage)
          This method allows the logging of an exceptional event.
 void logNormalEvent(String aMessage)
          This method allows the logging of a 'normal' event.
 void logTime(String aMessage)
          This method allows the caller to have the logger record a timestamp (implementation specific format and content, although 'date - time' is a good rule of thumb) along with the specified message.
 

Method Detail

logTime

void logTime(String aMessage)
This method allows the caller to have the logger record a timestamp (implementation specific format and content, although 'date - time' is a good rule of thumb) along with the specified message.

Parameters:
aMessage - String with the message to display after the timestamp.

logNormalEvent

void logNormalEvent(String aMessage)
This method allows the logging of a 'normal' event.

Parameters:
aMessage - String with a normal operation message.

logExceptionalEvent

void logExceptionalEvent(String aMessage)
This method allows the logging of an exceptional event.

Parameters:
aMessage - String with the exceptional message to log.


Copyright © 2012. All Rights Reserved.