com.puppycrawl.tools.checkstyle
Interface AuditListener

All Superinterfaces:

java.util.EventListener

All Known Implementing Classes:

DefaultLogger, XMLLogger

public interface AuditListener

extends java.util.EventListener

Listener in charge of receiving events from the Checker. Typical events sequence is:

 auditStarted
   (fileStarted
     (addError)*
     (addException)*
   fileFinished )*
   (addException)*
 auditFinished
 

Author:

Stephane Bailliez

Method Summary

void	addError(AuditEvent aEvt) notify that an audit error was discovered on a specific file
void	addException(AuditEvent aEvt, java.lang.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
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

Method Detail

auditStarted

public void auditStarted(AuditEvent aEvt)

notify that the audit is about to start

Parameters:

aEvt - the event details

auditFinished

public void auditFinished(AuditEvent aEvt)

notify that the audit is finished

Parameters:

aEvt - the event details

fileStarted

public void fileStarted(AuditEvent aEvt)

notify that audit is about to start on a specific file

Parameters:

aEvt - the event details

fileFinished

public void fileFinished(AuditEvent aEvt)

notify that audit is finished on a specific file

Parameters:

aEvt - the event details

addError

public void addError(AuditEvent aEvt)

notify that an audit error was discovered on a specific file

Parameters:

aEvt - the event details

addException

public void addException(AuditEvent aEvt,
                         java.lang.Throwable aThrowable)

notify that an exception happened while performing audit

Parameters:

aEvt - the event details

aThrowable - details of the exception