1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2014 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 * fileFinished )*
32 * auditFinished
33 * </pre>
34 * @author <a href="mailto:stephane.bailliez@wanadoo.fr">Stephane Bailliez</a>
35 */
36 public interface AuditListener
37 extends EventListener
38 {
39 /**
40 * Notify that the audit is about to start.
41 * @param evt the event details
42 */
43 void auditStarted(AuditEvent evt);
44
45 /**
46 * Notify that the audit is finished.
47 * @param evt the event details
48 */
49 void auditFinished(AuditEvent evt);
50
51 /**
52 * Notify that audit is about to start on a specific file.
53 * @param evt the event details
54 */
55 void fileStarted(AuditEvent evt);
56
57 /**
58 * Notify that audit is finished on a specific file.
59 * @param evt the event details
60 */
61 void fileFinished(AuditEvent evt);
62
63 /**
64 * Notify that an audit error was discovered on a specific file.
65 * @param evt the event details
66 */
67 void addError(AuditEvent evt);
68
69 /**
70 * Notify that an exception happened while performing audit.
71 * @param evt the event details
72 * @param throwable details of the exception
73 */
74 void addException(AuditEvent evt, Throwable throwable);
75 }