Source code: com/puppycrawl/tools/checkstyle/api/MessageDispatcher.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 /**
22 * Used by FileSetChecks to distribute AuditEvents to AuditListeners.
23 * @author lkuehne
24 */
25 public interface MessageDispatcher
26 {
27 /**
28 * Notify all listeners about the beginning of a file audit.
29 * @param aFileName the file to be audited
30 */
31 void fireFileStarted(String aFileName);
32
33 /**
34 * Notify all listeners about the end of a file audit.
35 * @param aFileName the audited file
36 */
37 void fireFileFinished(String aFileName);
38
39 /**
40 * Notify all listeners about the errors in a file.
41 * @param aFileName the audited file
42 * @param aErrors the audit errors from the file
43 */
44 void fireErrors(String aFileName, LocalizedMessage[] aErrors);
45 }