1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 the original author or authors.
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
20 package com.puppycrawl.tools.checkstyle.api;
21
22 import java.util.EventListener;
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 */
35 public interface AuditListener
36 extends EventListener {
37
38 /**
39 * Notify that the audit is about to start.
40 *
41 * @param event the event details
42 */
43 void auditStarted(AuditEvent event);
44
45 /**
46 * Notify that the audit is finished.
47 *
48 * @param event the event details
49 */
50 void auditFinished(AuditEvent event);
51
52 /**
53 * Notify that audit is about to start on a specific file.
54 *
55 * @param event the event details
56 */
57 void fileStarted(AuditEvent event);
58
59 /**
60 * Notify that audit is finished on a specific file.
61 *
62 * @param event the event details
63 */
64 void fileFinished(AuditEvent event);
65
66 /**
67 * Notify that an audit error was discovered on a specific file.
68 *
69 * @param event the event details
70 */
71 void addError(AuditEvent event);
72
73 /**
74 * Notify that an exception happened while performing audit.
75 *
76 * @param event the event details
77 * @param throwable details of the exception
78 */
79 void addException(AuditEvent event, Throwable throwable);
80
81 }