info.bioinfweb.commons.log

Class TextFileApplicationLogger

java.lang.Object

info.bioinfweb.commons.log.AbstractApplicationLogger

info.bioinfweb.commons.log.TextFileApplicationLogger

All Implemented Interfaces:

ApplicationLogger, java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class TextFileApplicationLogger
extends AbstractApplicationLogger
implements java.io.Closeable, java.io.Flushable

This implementation of ApplicationLogger appends all log messages to a text file, where every message is written to one line. Additional constructors also allow to write messages into any PrintWriter instead, so this class can also be used to send log messages to standard out or standard error.

Note that the close() method of this logger has to be called after the end of the logging process if messages are written to a file. Otherwise the file will not be terminated and information may be lost.

Author:

Ben Stöver

Constructor Summary

Constructors

Constructor and Description
TextFileApplicationLogger(java.io.File file) Creates a new instance of this class and appends all messaged to the specified file.
TextFileApplicationLogger(java.io.File file, boolean append) Creates a new instance of this class and writes all messaged to the specified file.
TextFileApplicationLogger(java.io.PrintWriter writer) Creates a new instance of this class that writes into the specified writer instead of a file.

Method Summary

Modifier and Type	Method and Description
void	addMessage(ApplicationLoggerMessage message) Outputs a usual message to the user.
void	close() Closes the underlying writer or the target file.
void	flush()
static TextFileApplicationLogger	newStandardErrorInstance() Creates a new instance of this class that writes to the standard error.
static TextFileApplicationLogger	newStandardOutInstance() Creates a new instance of this class that writes to the standard out.

Methods inherited from class info.bioinfweb.commons.log.AbstractApplicationLogger

addError, addError, addError, addError, addMessage, addMessage, addWarning, addWarning

Methods inherited from class java.lang.Object

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

Constructor Detail

TextFileApplicationLogger

public TextFileApplicationLogger(java.io.PrintWriter writer)

Creates a new instance of this class that writes into the specified writer instead of a file.

Parameters:

writer - the writer to write the messages into

Since:

3.2.0

TextFileApplicationLogger

public TextFileApplicationLogger(java.io.File file,
                                 boolean append)
                          throws java.io.IOException

Creates a new instance of this class and writes all messaged to the specified file.

Parameters:

file - the output file

append - Specify true here if you want messages to be appended to an existing file or false if an existing file shall be overwritten.

Throws:

java.io.IOException

TextFileApplicationLogger

public TextFileApplicationLogger(java.io.File file)
                          throws java.io.IOException

Creates a new instance of this class and appends all messaged to the specified file.

Parameters:

file - the output file

Throws:

java.io.IOException

Method Detail

newStandardOutInstance

public static TextFileApplicationLogger newStandardOutInstance()

Creates a new instance of this class that writes to the standard out.

Since:

3.2.0

newStandardErrorInstance

public static TextFileApplicationLogger newStandardErrorInstance()

Creates a new instance of this class that writes to the standard error.

Since:

3.2.0

addMessage

public void addMessage(ApplicationLoggerMessage message)

Description copied from interface: ApplicationLogger

Outputs a usual message to the user.

Specified by:

addMessage in interface ApplicationLogger

close

public void close()

Closes the underlying writer or the target file.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

See Also:

Closeable.close()

flush

public void flush()

Specified by:

flush in interface java.io.Flushable