Package org.apache.maven.plugins.checkstyle

Class CheckstyleReportGenerator

java.lang.Object
org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator
public class CheckstyleReportGenerator extends Object
Generate a report based on CheckstyleResults.
Version:
$Id$

  • Field Details

    • log

      private org.apache.maven.plugin.logging.Log log

    • basedir

      private final File basedir

    • bundle

      private final ResourceBundle bundle

    • sink

      private final org.apache.maven.doxia.sink.Sink sink

    • severityLevel

      private com.puppycrawl.tools.checkstyle.api.SeverityLevel severityLevel

    • checkstyleConfig

      private com.puppycrawl.tools.checkstyle.api.Configuration checkstyleConfig

    • enableRulesSummary

      private boolean enableRulesSummary

    • enableSeveritySummary

      private boolean enableSeveritySummary

    • enableFilesSummary

      private boolean enableFilesSummary

    • enableRSS

      private boolean enableRSS

    • siteTool

      private final org.apache.maven.doxia.tools.SiteTool siteTool

    • xrefLocation

      private String xrefLocation

    • treeWalkerNames

      private List<String> treeWalkerNames

    • iconTool

      private final IconTool iconTool

    • ruleset

      private final String ruleset

  • Constructor Details

    • CheckstyleReportGenerator

      public CheckstyleReportGenerator(org.apache.maven.doxia.sink.Sink sink, ResourceBundle bundle, File basedir, org.apache.maven.doxia.tools.SiteTool siteTool, String ruleset)

  • Method Details

    • getLog

      public org.apache.maven.plugin.logging.Log getLog()

    • setLog

      public void setLog(org.apache.maven.plugin.logging.Log log)

    • getTitle

      private String getTitle()

    • generateReport

      public void generateReport(CheckstyleResults results)

    • doHeading

      private void doHeading()

    • getConfigAttribute

      private String getConfigAttribute(com.puppycrawl.tools.checkstyle.api.Configuration config, CheckstyleReportGenerator.ChainedItem<com.puppycrawl.tools.checkstyle.api.Configuration> parentConfiguration, String attributeName, String defaultValue)
      Get the value of the specified attribute from the Checkstyle configuration. If parentConfigurations is non-null and non-empty, the parent configurations are searched if the attribute cannot be found in the current configuration. If the attribute is still not found, the specified default value will be returned.
      Parameters:
      config - The current Checkstyle configuration
      parentConfiguration - The configuration of the parent of the current configuration
      attributeName - The name of the attribute
      defaultValue - The default value to use if the attribute cannot be found in any configuration
      Returns:
      The value of the specified attribute

    • doRulesSummary

      private void doRulesSummary(CheckstyleResults results)
      Create the rules summary section of the report.
      Parameters:
      results - The results to summarize

    • doRuleRow

      private void doRuleRow(CheckstyleReportGenerator.ConfReference ref, CheckstyleResults results, String previousCategory)
      Create a summary for one Checkstyle rule.
      Parameters:
      ref - The configuration reference for the row
      results - The results to summarize
      previousCategory - The previous row's category

    • matchRule

      public boolean matchRule(com.puppycrawl.tools.checkstyle.api.AuditEvent event, String ruleName, String expectedMessage, String expectedSeverity)
      Check if a violation matches a rule.
      Parameters:
      event - the violation to check
      ruleName - The name of the rule
      expectedMessage - A message that, if it's not null, will be matched to the message from the violation
      expectedSeverity - A severity that, if it's not null, will be matched to the severity from the violation
      Returns:
      The number of rule violations

    • doSeveritySummary

      private void doSeveritySummary(CheckstyleResults results)

    • doFilesSummary

      private void doFilesSummary(CheckstyleResults results)

    • doDetails

      private void doDetails(CheckstyleResults results)

    • doFileEvents

      private void doFileEvents(List<com.puppycrawl.tools.checkstyle.api.AuditEvent> eventList, String filename)

    • getSeverityLevel

      public com.puppycrawl.tools.checkstyle.api.SeverityLevel getSeverityLevel()

    • setSeverityLevel

      public void setSeverityLevel(com.puppycrawl.tools.checkstyle.api.SeverityLevel severityLevel)

    • isEnableRulesSummary

      public boolean isEnableRulesSummary()

    • setEnableRulesSummary

      public void setEnableRulesSummary(boolean enableRulesSummary)

    • isEnableSeveritySummary

      public boolean isEnableSeveritySummary()

    • setEnableSeveritySummary

      public void setEnableSeveritySummary(boolean enableSeveritySummary)

    • isEnableFilesSummary

      public boolean isEnableFilesSummary()

    • setEnableFilesSummary

      public void setEnableFilesSummary(boolean enableFilesSummary)

    • isEnableRSS

      public boolean isEnableRSS()

    • setEnableRSS

      public void setEnableRSS(boolean enableRSS)

    • getXrefLocation

      public String getXrefLocation()

    • setXrefLocation

      public void setXrefLocation(String xrefLocation)

    • getCheckstyleConfig

      public com.puppycrawl.tools.checkstyle.api.Configuration getCheckstyleConfig()

    • setCheckstyleConfig

      public void setCheckstyleConfig(com.puppycrawl.tools.checkstyle.api.Configuration config)

    • setTreeWalkerNames

      public void setTreeWalkerNames(List<String> treeWalkerNames)

    • getTreeWalkerNames

      public List<String> getTreeWalkerNames()

    • getCheckstyleVersion

      private String getCheckstyleVersion()
      Get the effective Checkstyle version at runtime.
      Returns:
      the MANIFEST implementation version of Checkstyle API package (can be null)

    • sortConfiguration

      public List<CheckstyleReportGenerator.ConfReference> sortConfiguration(CheckstyleResults results)

    • sortConfiguration

      private void sortConfiguration(List<CheckstyleReportGenerator.ConfReference> result, com.puppycrawl.tools.checkstyle.api.Configuration config, CheckstyleReportGenerator.ChainedItem<com.puppycrawl.tools.checkstyle.api.Configuration> parent, CheckstyleResults results)