Class CheckstyleCheckerListener

  • All Implemented Interfaces:
    com.puppycrawl.tools.checkstyle.api.AuditListener, com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable, EventListener

    public class CheckstyleCheckerListener
    extends com.puppycrawl.tools.checkstyle.api.AutomaticBean
    implements com.puppycrawl.tools.checkstyle.api.AuditListener
    Listener in charge of receiving events from the Checker.
    Version:
    $Id$
    Author:
    Emmanuel Venisse, Vincent Siveton
    • Constructor Detail

      • CheckstyleCheckerListener

        public CheckstyleCheckerListener​(File sourceDirectory)
        Parameters:
        sourceDirectory - assume that is sourceDirectory is a not null directory and exists
      • CheckstyleCheckerListener

        public CheckstyleCheckerListener​(File sourceDirectory,
                                         com.puppycrawl.tools.checkstyle.api.Configuration configuration)
        Parameters:
        sourceDirectory - assume that is sourceDirectory is a not null directory and exists
        configuration - Checkstyle configuration
        Since:
        2.5
      • CheckstyleCheckerListener

        public CheckstyleCheckerListener​(com.puppycrawl.tools.checkstyle.api.Configuration configuration)
        Parameters:
        configuration - Checkstyle configuration
        Since:
        2.5
    • Method Detail

      • addSourceDirectory

        public void addSourceDirectory​(File sourceDirectory)
        Parameters:
        sourceDirectory - assume that is sourceDirectory is a not null directory and exists
      • setSeverityLevelFilter

        public void setSeverityLevelFilter​(com.puppycrawl.tools.checkstyle.api.SeverityLevel severityLevel)
        Parameters:
        severityLevel - The severity level of the events to listen to.
      • getSeverityLevelFilter

        public com.puppycrawl.tools.checkstyle.api.SeverityLevel getSeverityLevelFilter()
        Returns:
        The severity level of the events to listen to.
      • auditStarted

        public void auditStarted​(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
        Specified by:
        auditStarted in interface com.puppycrawl.tools.checkstyle.api.AuditListener
      • auditFinished

        public void auditFinished​(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
        Specified by:
        auditFinished in interface com.puppycrawl.tools.checkstyle.api.AuditListener
      • fileStarted

        public void fileStarted​(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
        Specified by:
        fileStarted in interface com.puppycrawl.tools.checkstyle.api.AuditListener
      • fileFinished

        public void fileFinished​(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
        Specified by:
        fileFinished in interface com.puppycrawl.tools.checkstyle.api.AuditListener
      • addError

        public void addError​(com.puppycrawl.tools.checkstyle.api.AuditEvent event)
        Specified by:
        addError in interface com.puppycrawl.tools.checkstyle.api.AuditListener
      • addException

        public void addException​(com.puppycrawl.tools.checkstyle.api.AuditEvent event,
                                 Throwable throwable)
        Specified by:
        addException in interface com.puppycrawl.tools.checkstyle.api.AuditListener
      • getResults

        public CheckstyleResults getResults()
        Returns:
        The results of Checkstyle invocation.
      • setResults

        public void setResults​(CheckstyleResults results)
        Parameters:
        results - The results of Checkstyle invocation.
      • getCheckstyleConfiguration

        public com.puppycrawl.tools.checkstyle.api.Configuration getCheckstyleConfiguration()
        Returns:
        The configuration of Checkstyle to use.
        Since:
        2.5
      • setCheckstyleConfiguration

        public void setCheckstyleConfiguration​(com.puppycrawl.tools.checkstyle.api.Configuration checkstyleConfiguration)
        Parameters:
        checkstyleConfiguration - The configuration of Checkstyle to use.
        Since:
        2.5