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.SortedSet;
23
24 /**
25 * Used by FileSetChecks to distribute AuditEvents to AuditListeners.
26 */
27 public interface MessageDispatcher {
28
29 /**
30 * Notify all listeners about the beginning of a file audit.
31 *
32 * @param fileName the file to be audited
33 */
34 void fireFileStarted(String fileName);
35
36 /**
37 * Notify all listeners about the end of a file audit.
38 *
39 * @param fileName the audited file
40 */
41 void fireFileFinished(String fileName);
42
43 /**
44 * Notify all listeners about the violations in a file.
45 *
46 * @param fileName the audited file
47 * @param errors the violations from the file
48 */
49 void fireErrors(String fileName, SortedSet<Violation> errors);
50
51 }