Package org.anchoranalysis.experiment.log

Class TextFileMessageLogger

Object

TextFileMessageLogger

All Implemented Interfaces:

MessageLogger, StatefulMessageLogger

public class TextFileMessageLogger
extends Object
implements StatefulMessageLogger

Logs messages to a text-file.

Both the path of text-file can be determined in different ways by the constructor, and whether it is written at all.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
TextFileMessageLogger(String filePath, ErrorReporter errorReporter)	Constructs a logger that (always) writes messages to a text-file with a specific path.
TextFileMessageLogger(String outputName, OutputterChecked outputter, ErrorReporter errorReporter)	Constructs a logger that (maybe) writes messages to a text-file, with a path based upon an output name applied to a OutputterChecked.

Method Summary

Modifier and Type	Method	Description
void	close(boolean successful, boolean warningOccurred)	Stops logging.
void	log(String message)	Logs a message.
void	logFormatted(String formatString, Object... args)	Logs a message, derived from a format-string.
void	start()	Starts logging.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.anchoranalysis.core.log.MessageLogger

logEmptyLine

Constructor Details

TextFileMessageLogger

public TextFileMessageLogger(String filePath,
 ErrorReporter errorReporter)

Constructs a logger that (always) writes messages to a text-file with a specific path.

Parameters:

filePath - path to write the log to

errorReporter - error-reporter an error is outputted here if the log cannot be created, and no further logging occurs.

TextFileMessageLogger

public TextFileMessageLogger(String outputName,
 OutputterChecked outputter,
 ErrorReporter errorReporter)

Constructs a logger that (maybe) writes messages to a text-file, with a path based upon an output name applied to a OutputterChecked.

The message-log will only be outputted, if allowed by the OutputterChecked.

Parameters:

outputName - output-name

outputter - output-manager

errorReporter - error-reporter an error is outputted here if the log cannot be created, and no further logging occurs.

Method Details

logFormatted

public void logFormatted(String formatString,
 Object... args)

Description copied from interface: MessageLogger

Logs a message, derived from a format-string.

Specified by:

logFormatted in interface MessageLogger

Parameters:

formatString - a format string like in String.format(java.lang.String, java.lang.Object...).

args - the arguments that match the placeholder in formatString like in String.format(java.lang.String, java.lang.Object...).

start

public void start()
           throws OperationFailedException

Description copied from interface: StatefulMessageLogger

Starts logging.

This must be called once before any logging occurs.

Specified by:

start in interface StatefulMessageLogger

Throws:

OperationFailedException - if logging cannot be successfully started.

log

public void log(String message)

Description copied from interface: MessageLogger

Logs a message.

Specified by:

log in interface MessageLogger

Parameters:

message - the message to log.

close

public void close(boolean successful,
 boolean warningOccurred)

Description copied from interface: StatefulMessageLogger

Stops logging.

This must be called once after all logging has occurred.

Specified by:

close in interface StatefulMessageLogger

Parameters:

successful - true when the task completed successfully.

warningOccurred - true if at least one warning has occurred, false otherwise.