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

    Modifier and Type
    Method
    Description
    void
    fireErrors(String fileName, SortedSet<Violation> errors)
    Notify all listeners about the violations in a file.
    void
    fireFileFinished(String fileName)
    Notify all listeners about the end of a file audit.
    void
    fireFileStarted(String fileName)
    Notify all listeners about the beginning of a file audit.

  • Method Details

    • fireFileStarted

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

    • fireFileFinished

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

    • fireErrors

      void fireErrors(String fileName, SortedSet<Violation> errors)
      Notify all listeners about the violations in a file.
      Parameters:
      fileName - the audited file
      errors - the violations from the file