com.puppycrawl.tools.checkstyle

Class DefaultLogger

Implemented Interfaces:
AuditListener, EventListener, Configurable, Contextualizable

public class DefaultLogger
extends AutomaticBean
implements AuditListener

Simple plain logger for text output. This is maybe not very suitable for a text output into a file since it does not need all 'audit finished' and so on stuff, but it looks good on stdout anyway. If there is really a problem this is what XMLLogger is for. It gives structure.
Author:
Stephane Bailliez
See Also:
XMLLogger

Constructor Summary

DefaultLogger(OutputStream aOS, boolean aCloseStreamsAfterUse)
Creates a new DefaultLogger instance.
DefaultLogger(OutputStream aInfoStream, boolean aCloseInfoAfterUse, OutputStream aErrorStream, boolean aCloseErrorAfterUse)
Creates a new DefaultLogger instance.

Method Summary

void
addError(AuditEvent aEvt)
Print an Emacs compliant line on the error stream.
void
addException(AuditEvent aEvt, Throwable aThrowable)
void
auditFinished(AuditEvent aEvt)
void
auditStarted(AuditEvent aEvt)
protected void
closeStreams()
Flushes the output streams and closes them if needed.
void
fileFinished(AuditEvent aEvt)
void
fileStarted(AuditEvent aEvt)

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Constructor Details

DefaultLogger

public DefaultLogger(OutputStream aOS,
                     boolean aCloseStreamsAfterUse)
Creates a new DefaultLogger instance.
Parameters:
aOS - where to log infos and errors
aCloseStreamsAfterUse - if aOS should be closed in auditFinished()

DefaultLogger

public DefaultLogger(OutputStream aInfoStream,
                     boolean aCloseInfoAfterUse,
                     OutputStream aErrorStream,
                     boolean aCloseErrorAfterUse)
Creates a new DefaultLogger instance.
Parameters:
aInfoStream - the OutputStream for info messages
aCloseInfoAfterUse - auditFinished should close aInfoStream
aErrorStream - the OutputStream for error messages
aCloseErrorAfterUse - auditFinished should close aErrorStream

Method Details

addError

public void addError(AuditEvent aEvt)
Print an Emacs compliant line on the error stream. If the column number is non zero, then also display it.
Specified by:
addError in interface AuditListener
Parameters:
aEvt -
See Also:
AuditListener

addException

public void addException(AuditEvent aEvt,
                         Throwable aThrowable)
Specified by:
addException in interface AuditListener

auditFinished

public void auditFinished(AuditEvent aEvt)
Specified by:
auditFinished in interface AuditListener

auditStarted

public void auditStarted(AuditEvent aEvt)
Specified by:
auditStarted in interface AuditListener

closeStreams

protected void closeStreams()
Flushes the output streams and closes them if needed.

fileFinished

public void fileFinished(AuditEvent aEvt)
Specified by:
fileFinished in interface AuditListener

fileStarted

public void fileStarted(AuditEvent aEvt)
Specified by:
fileStarted in interface AuditListener