Package org.anchoranalysis.experiment.log

Class FailureOnlyMessageLogger

Object

FailureOnlyMessageLogger

All Implemented Interfaces:

MessageLogger, StatefulMessageLogger

public class FailureOnlyMessageLogger
extends Object
implements StatefulMessageLogger

Writes text to a file, but only if close(boolean, boolean) is called with successful==true.

The text cannot be written immediately, so is saved until close(boolean, boolean) is called.

Author:

Owen Feehan

Constructor Summary

Constructors

Constructor	Description
FailureOnlyMessageLogger(String outputName, OutputterChecked outputter, ErrorReporter errorReporter, boolean considerWarningAsFailure)	Creates a new FailureOnlyMessageLogger instance.

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

FailureOnlyMessageLogger

public FailureOnlyMessageLogger(String outputName,
 OutputterChecked outputter,
 ErrorReporter errorReporter,
 boolean considerWarningAsFailure)

Creates a new FailureOnlyMessageLogger instance.

Parameters:

outputName -

outputter -

errorReporter -

considerWarningAsFailure - If true, any warning message is considered as a failure.

Method Details

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.

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()

Description copied from interface: StatefulMessageLogger

Starts logging.

This must be called once before any logging occurs.

Specified by:

start in interface StatefulMessageLogger

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.