Package com.puppycrawl.tools.checkstyle.api

Interface MessageDispatcher

  • All Known Implementing Classes:
    Checker
    public interface MessageDispatcher
    Used by FileSetChecks to distribute AuditEvents to AuditListeners.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void fireErrors​(java.lang.String fileName, java.util.SortedSet<LocalizedMessage> errors)
      Notify all listeners about the errors in a file.
      void fireFileFinished​(java.lang.String fileName)
      Notify all listeners about the end of a file audit.
      void fireFileStarted​(java.lang.String fileName)
      Notify all listeners about the beginning of a file audit.

    • Method Detail

      • fireFileStarted

        void fireFileStarted​(java.lang.String fileName)
        Notify all listeners about the beginning of a file audit.
        Parameters:
        fileName - the file to be audited

      • fireFileFinished

        void fireFileFinished​(java.lang.String fileName)
        Notify all listeners about the end of a file audit.
        Parameters:
        fileName - the audited file

      • fireErrors

        void fireErrors​(java.lang.String fileName,
                java.util.SortedSet<LocalizedMessage> errors)
        Notify all listeners about the errors in a file.
        Parameters:
        fileName - the audited file
        errors - the audit errors from the file