Package com.compomics.software.log

Class CliLogger

java.lang.Object

com.compomics.software.log.CliLogger

All Implemented Interfaces:

AutoCloseable

public class CliLogger
extends Object
implements AutoCloseable

Simple logger.

Author:

Marc Vaudel

Constructor Summary

Constructors

Constructor	Description
CliLogger(File logFile)	Constructor.
CliLogger(File logFile, String cliName, String version)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()
void	logError(String message)	Logs an error.
void	logMessage(String message)	Logs a message.
void	writeComment(String key, String value)	Write a comment line as '# key: value'.
void	writeHeaders()	Writes the headers to the files.

Methods inherited from class java.lang.Object

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

Constructor Details

CliLogger

public CliLogger(File logFile)

Constructor.

Parameters:

logFile - the file where to write the log

CliLogger

public CliLogger(File logFile,
 String cliName,
 String version)

Constructor.

Parameters:

logFile - The file where to write the log.

cliName - The name of the CLI.

version - The version of the CLI.

Method Details

writeComment

public void writeComment(String key,
 String value)

Write a comment line as '# key: value'.

Parameters:

key - the key

value - the value

writeHeaders

public void writeHeaders()

Writes the headers to the files.

logMessage

public void logMessage(String message)

Logs a message.

Parameters:

message - the message

logError

public void logError(String message)

Logs an error.

Parameters:

message - the error message

close

public void close()

Specified by:

close in interface AutoCloseable