View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2017 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   * @author lkuehne
27   */
28  public interface MessageDispatcher {
29      /**
30       * Notify all listeners about the beginning of a file audit.
31       * @param fileName the file to be audited
32       */
33      void fireFileStarted(String fileName);
34  
35      /**
36       * Notify all listeners about the end of a file audit.
37       * @param fileName the audited file
38       */
39      void fireFileFinished(String fileName);
40  
41      /**
42       * Notify all listeners about the errors in a file.
43       * @param fileName the audited file
44       * @param errors the audit errors from the file
45       */
46      void fireErrors(String fileName, SortedSet<LocalizedMessage> errors);
47  }