com.compomics.util.general

Class FileLoggerImplementation

java.lang.Object

com.compomics.util.general.FileLoggerImplementation

All Implemented Interfaces:

Logger

public class FileLoggerImplementation
extends Object
implements Logger

This class implements the Logger interface for logging to a file.

Author:

Lennart Martens

Constructor Summary

Constructors

Constructor and Description
FileLoggerImplementation(String aFilename) This constructor takes the name for the log file and sets a default timestamp format: "dd/MM/yyyy - HH:mm:ss".
FileLoggerImplementation(String aFilename, String aFormat) This constructor takes the name for the log file and the timestamp format.

Method Summary

Modifier and Type	Method and Description
void	close() This method closes the stream to the output file.
protected void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileLoggerImplementation

public FileLoggerImplementation(String aFilename)
                         throws IOException

This constructor takes the name for the log file and sets a default timestamp format: "dd/MM/yyyy - HH:mm:ss".

Parameters:

aFilename - String with the filename for the log file. Note that if the file already exists, it is silently overwritten.

Throws:

IOException - when the file could not be created or written to.

FileLoggerImplementation

public FileLoggerImplementation(String aFilename,
                                String aFormat)
                         throws IOException

This constructor takes the name for the log file and the timestamp format.

Parameters:

aFilename - String with the filename for the log file. Note that if the file already exists, it is silently overwritten.

aFormat - String with the format for the timestamp.

Throws:

IOException - when the file could not be created or written to.

Method Detail

logTime

public 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.

Specified by:

logTime in interface Logger

Parameters:

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

logNormalEvent

public void logNormalEvent(String aMessage)

This method allows the logging of a 'normal' event.

Specified by:

logNormalEvent in interface Logger

Parameters:

aMessage - String with a normal operation message.

logExceptionalEvent

public void logExceptionalEvent(String aMessage)

This method allows the logging of an exceptional event.

Specified by:

logExceptionalEvent in interface Logger

Parameters:

aMessage - String with the exceptional message to log.

finalize

protected void finalize()
                 throws Throwable

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.

Overrides:

finalize in class Object

Throws:

Throwable - the Exception raised by this method

close

public void close()

This method closes the stream to the output file.