com.puppycrawl.tools.checkstyle.api

Interface AuditListener

All Superinterfaces:

EventListener

All Known Implementing Classes:

DefaultLogger, SeverityLevelCounter, XMLLogger

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

Methods

Modifier and Type	Method and Description
void	addError(AuditEvent aEvt) Notify that an audit error was discovered on a specific file.
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.
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

void auditStarted(AuditEvent aEvt)

Notify that the audit is about to start.

Parameters:

aEvt - the event details

auditFinished

void auditFinished(AuditEvent aEvt)

Notify that the audit is finished.

Parameters:

aEvt - the event details

fileStarted

void fileStarted(AuditEvent aEvt)

Notify that audit is about to start on a specific file.

Parameters:

aEvt - the event details

fileFinished

void fileFinished(AuditEvent aEvt)

Notify that audit is finished on a specific file.

Parameters:

aEvt - the event details

addError

void addError(AuditEvent aEvt)

Notify that an audit error was discovered on a specific file.

Parameters:

aEvt - the event details

addException

void addException(AuditEvent aEvt,
                Throwable aThrowable)

Notify that an exception happened while performing audit.

Parameters:

aEvt - the event details

aThrowable - details of the exception