AuditListener

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ api overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of com.puppycrawl.tools.checkstyle.api.AuditListener

SOURCE |

Download com.puppycrawl.tools.checkstyle.api.AuditListener

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.puppycrawl.tools.checkstyle.api
Interface AuditListener

All Superinterfaces:: java.util.EventListener

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

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.

auditFinished

public void auditFinished(AuditEvent aEvt)

Notify that the audit is finished.

fileStarted

public void fileStarted(AuditEvent aEvt)

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

fileFinished

public void fileFinished(AuditEvent aEvt)

Notify that audit is finished on a specific file.

addError

public void addError(AuditEvent aEvt)

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

addException

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

Notify that an exception happened while performing audit.