Source code: com/puppycrawl/tools/checkstyle/api/AuditListener.java
1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2003 Oliver Burn
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ////////////////////////////////////////////////////////////////////////////////
19 package com.puppycrawl.tools.checkstyle.api;
20
21 import java.util.EventListener;
22
23
24 /**
25 * Listener in charge of receiving events from the Checker.
26 * Typical events sequence is:
27 * <pre>
28 * auditStarted
29 * (fileStarted
30 * (addError)*
31 * (addException)*
32 * fileFinished )*
33 * (addException)*
34 * auditFinished
35 * </pre>
36 * @author <a href="mailto:stephane.bailliez@wanadoo.fr">Stephane Bailliez</a>
37 */
38 public interface AuditListener
39 extends EventListener
40 {
41 /**
42 * Notify that the audit is about to start.
43 * @param aEvt the event details
44 */
45 void auditStarted(AuditEvent aEvt);
46
47 /**
48 * Notify that the audit is finished.
49 * @param aEvt the event details
50 */
51 void auditFinished(AuditEvent aEvt);
52
53 /**
54 * Notify that audit is about to start on a specific file.
55 * @param aEvt the event details
56 */
57 void fileStarted(AuditEvent aEvt);
58
59 /**
60 * Notify that audit is finished on a specific file.
61 * @param aEvt the event details
62 */
63 void fileFinished(AuditEvent aEvt);
64
65 /**
66 * Notify that an audit error was discovered on a specific file.
67 * @param aEvt the event details
68 */
69 void addError(AuditEvent aEvt);
70
71 /**
72 * Notify that an exception happened while performing audit.
73 * @param aEvt the event details
74 * @param aThrowable details of the exception
75 */
76 void addException(AuditEvent aEvt, Throwable aThrowable);
77 }