Interface AuditListener
-
- All Superinterfaces:
EventListener
- All Known Implementing Classes:
DefaultLogger
,MetadataGeneratorLogger
,SarifLogger
,SeverityLevelCounter
,XMLLogger
,XpathFileGeneratorAuditListener
public interface AuditListener extends EventListener
Listener in charge of receiving events from the Checker. Typical events sequence is:auditStarted (fileStarted (addError)* fileFinished )* auditFinished
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addError(AuditEvent event)
Notify that an audit error was discovered on a specific file.void
addException(AuditEvent event, Throwable throwable)
Notify that an exception happened while performing audit.void
auditFinished(AuditEvent event)
Notify that the audit is finished.void
auditStarted(AuditEvent event)
Notify that the audit is about to start.void
fileFinished(AuditEvent event)
Notify that audit is finished on a specific file.void
fileStarted(AuditEvent event)
Notify that audit is about to start on a specific file.
-
-
-
Method Detail
-
auditStarted
void auditStarted(AuditEvent event)
Notify that the audit is about to start.- Parameters:
event
- the event details
-
auditFinished
void auditFinished(AuditEvent event)
Notify that the audit is finished.- Parameters:
event
- the event details
-
fileStarted
void fileStarted(AuditEvent event)
Notify that audit is about to start on a specific file.- Parameters:
event
- the event details
-
fileFinished
void fileFinished(AuditEvent event)
Notify that audit is finished on a specific file.- Parameters:
event
- the event details
-
addError
void addError(AuditEvent event)
Notify that an audit error was discovered on a specific file.- Parameters:
event
- the event details
-
addException
void addException(AuditEvent event, Throwable throwable)
Notify that an exception happened while performing audit.- Parameters:
event
- the event detailsthrowable
- details of the exception
-
-