com.puppycrawl.tools.checkstyle
Class DefaultLogger

java.lang.Object
  extended by com.puppycrawl.tools.checkstyle.api.AutomaticBean
      extended by com.puppycrawl.tools.checkstyle.DefaultLogger
All Implemented Interfaces:
AuditListener, Configurable, Contextualizable, EventListener

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)
          Notify that an exception happened while performing audit.
 void auditFinished(AuditEvent aEvt)
          Notify that the audit is finished.
 void auditStarted(AuditEvent aEvt)
          Notify that the audit is about to start.
protected  void closeStreams()
          Flushes the output streams and closes them if needed.
 void fileFinished(AuditEvent aEvt)
          Notify that audit is finished on a specific file.
 void fileStarted(AuditEvent aEvt)
          Notify that audit is about to start on a specific file.
 
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

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 Detail

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 - the event details
See Also:
AuditListener

addException

public void addException(AuditEvent aEvt,
                         Throwable aThrowable)
Notify that an exception happened while performing audit.

Specified by:
addException in interface AuditListener
Parameters:
aEvt - the event details
aThrowable - details of the exception

auditStarted

public void auditStarted(AuditEvent aEvt)
Notify that the audit is about to start.

Specified by:
auditStarted in interface AuditListener
Parameters:
aEvt - the event details

fileFinished

public void fileFinished(AuditEvent aEvt)
Notify that audit is finished on a specific file.

Specified by:
fileFinished in interface AuditListener
Parameters:
aEvt - the event details

fileStarted

public void fileStarted(AuditEvent aEvt)
Notify that audit is about to start on a specific file.

Specified by:
fileStarted in interface AuditListener
Parameters:
aEvt - the event details

auditFinished

public void auditFinished(AuditEvent aEvt)
Notify that the audit is finished.

Specified by:
auditFinished in interface AuditListener
Parameters:
aEvt - the event details

closeStreams

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


Back to the Checkstyle Home Page