Package org.apache.maven.plugins.checkstyle

Class CheckstyleReportRenderer

java.lang.Object
org.apache.maven.reporting.AbstractMavenReportRenderer
org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer
All Implemented Interfaces:
org.apache.maven.reporting.MavenReportRenderer
public class CheckstyleReportRenderer extends org.apache.maven.reporting.AbstractMavenReportRenderer
Generate a report based on CheckstyleResults.

  • Field Details

    • NO_TEXT

      private static final int NO_TEXT
      See Also:

    • TEXT_SIMPLE

      private static final int TEXT_SIMPLE
      See Also:

    • TEXT_TITLE

      private static final int TEXT_TITLE
      See Also:

    • TEXT_ABBREV

      private static final int TEXT_ABBREV
      See Also:

    • i18n

      private final org.codehaus.plexus.i18n.I18N i18n

    • locale

      private final Locale locale

    • project

      private final org.apache.maven.project.MavenProject project

    • checkstyleConfig

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

    • enableRulesSummary

      private final boolean enableRulesSummary

    • enableSeveritySummary

      private final boolean enableSeveritySummary

    • enableFilesSummary

      private final boolean enableFilesSummary

    • siteTool

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

    • xrefLocation

      private String xrefLocation

    • xrefTestLocation

      private String xrefTestLocation

    • testSourceDirectories

      private List<File> testSourceDirectories

    • treeWalkerNames

      private List<String> treeWalkerNames

    • ruleset

      private final String ruleset

    • results

      private final CheckstyleResults results

  • Constructor Details

    • CheckstyleReportRenderer

      public CheckstyleReportRenderer(org.apache.maven.doxia.sink.Sink sink, org.codehaus.plexus.i18n.I18N i18n, Locale locale, org.apache.maven.project.MavenProject project, org.apache.maven.doxia.tools.SiteTool siteTool, String ruleset, String xrefLocation, String xrefTestLocation, List<File> testSourceDirectories, boolean enableRulesSummary, boolean enableSeveritySummary, boolean enableFilesSummary, CheckstyleResults results)

  • Method Details

    • getTitle

      public String getTitle()
      Specified by:
      getTitle in interface org.apache.maven.reporting.MavenReportRenderer
      Specified by:
      getTitle in class org.apache.maven.reporting.AbstractMavenReportRenderer

    • getI18nString

      private String getI18nString(String key)
      Parameters:
      key - The key.
      Returns:
      The translated string.

    • renderBody

      protected void renderBody()
      Specified by:
      renderBody in class org.apache.maven.reporting.AbstractMavenReportRenderer

    • getConfigAttribute

      private String getConfigAttribute(com.puppycrawl.tools.checkstyle.api.Configuration config, CheckstyleReportRenderer.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

    • renderRulesSummarySection

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

    • renderRuleRow

      private void renderRuleRow(CheckstyleReportRenderer.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

    • renderSeveritySummarySection

      private void renderSeveritySummarySection()

    • renderFilesSummarySection

      private void renderFilesSummarySection()

    • renderDetailsSection

      private void renderDetailsSection()

    • renderFileEvents

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

    • getEffectiveXrefLocation

      private String getEffectiveXrefLocation(List<com.puppycrawl.tools.checkstyle.api.AuditEvent> eventList)

    • isTestSource

      private boolean isTestSource(String absoluteFilename)

    • setTreeWalkerNames

      public void setTreeWalkerNames(List<String> treeWalkerNames)

    • iconSeverity

      private void iconSeverity(String level, int textType)
      Render an icon of given level with associated text.
      Parameters:
      level - one of INFO, WARNING or ERROR constants
      textType - one of NO_TEXT, TEXT_SIMPLE, TEXT_TITLE or TEXT_ABBREV constants

    • 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<CheckstyleReportRenderer.ConfReference> sortConfiguration(CheckstyleResults results)

    • sortConfiguration

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