com.puppycrawl.tools.checkstyle.api

Interface AuditListener

public interface AuditListener extends EventListener

Listener in charge of receiving events from the Checker. Typical events sequence is:
 auditStarted
   (fileStarted
     (addError)*
   fileFinished )*
 auditFinished
 

Author: Stephane Bailliez

Method Summary
voidaddError(AuditEvent aEvt)
Notify that an audit error was discovered on a specific file.
voidaddException(AuditEvent aEvt, Throwable aThrowable)
Notify that an exception happened while performing audit.
voidauditFinished(AuditEvent aEvt)
Notify that the audit is finished.
voidauditStarted(AuditEvent aEvt)
Notify that the audit is about to start.
voidfileFinished(AuditEvent aEvt)
Notify that audit is finished on a specific file.
voidfileStarted(AuditEvent aEvt)
Notify that audit is about to start on a specific file.

Method Detail

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, Throwable aThrowable)
Notify that an exception happened while performing audit.

Parameters: aEvt the event details aThrowable details of the exception

auditFinished

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

Parameters: aEvt the event details

auditStarted

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

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

fileStarted

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

Parameters: aEvt the event details