001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2024 the original author or authors.
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///////////////////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.api;
021
022import java.util.SortedSet;
023
024/**
025 * Used by FileSetChecks to distribute AuditEvents to AuditListeners.
026 */
027public interface MessageDispatcher {
028
029    /**
030     * Notify all listeners about the beginning of a file audit.
031     *
032     * @param fileName the file to be audited
033     */
034    void fireFileStarted(String fileName);
035
036    /**
037     * Notify all listeners about the end of a file audit.
038     *
039     * @param fileName the audited file
040     */
041    void fireFileFinished(String fileName);
042
043    /**
044     * Notify all listeners about the violations in a file.
045     *
046     * @param fileName the audited file
047     * @param errors the violations from the file
048     */
049    void fireErrors(String fileName, SortedSet<Violation> errors);
050
051}