001//////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code for adherence to a set of rules. 003// Copyright (C) 2001-2014 Oliver Burn 004// 005// This library is free software; you can redistribute it and/or 006// modify it under the terms of the GNU Lesser General Public 007// License as published by the Free Software Foundation; either 008// version 2.1 of the License, or (at your option) any later version. 009// 010// This library is distributed in the hope that it will be useful, 011// but WITHOUT ANY WARRANTY; without even the implied warranty of 012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 013// Lesser General Public License for more details. 014// 015// You should have received a copy of the GNU Lesser General Public 016// License along with this library; if not, write to the Free Software 017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 018//////////////////////////////////////////////////////////////////////////////// 019package com.puppycrawl.tools.checkstyle.api; 020 021import java.util.SortedSet; 022 023/** 024 * Used by FileSetChecks to distribute AuditEvents to AuditListeners. 025 * @author lkuehne 026 */ 027public interface MessageDispatcher 028{ 029 /** 030 * Notify all listeners about the beginning of a file audit. 031 * @param fileName the file to be audited 032 */ 033 void fireFileStarted(String fileName); 034 035 /** 036 * Notify all listeners about the end of a file audit. 037 * @param fileName the audited file 038 */ 039 void fireFileFinished(String fileName); 040 041 /** 042 * Notify all listeners about the errors in a file. 043 * @param fileName the audited file 044 * @param errors the audit errors from the file 045 */ 046 void fireErrors(String fileName, SortedSet<LocalizedMessage> errors); 047}