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 Summary

Fields inherited from class org.apache.maven.reporting.AbstractMavenReportRenderer

sink

Constructor Summary

Constructors

Constructor and Description

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 Summary

Modifier and Type	Method and Description
String	getTitle()
boolean	matchRule(com.puppycrawl.tools.checkstyle.api.AuditEvent event, String ruleName, String expectedMessage, String expectedSeverity) Check if a violation matches a rule.
protected void	renderBody()
void	setTreeWalkerNames(List<String> treeWalkerNames)
List<org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer.ConfReference>	sortConfiguration(CheckstyleResults results)

Methods inherited from class org.apache.maven.reporting.AbstractMavenReportRenderer

createLinkPatternedText, endSection, endTable, javaScript, link, linkPatternedText, paragraph, propertiesToString, render, startSection, startSection, startTable, startTable, tableCaption, tableCell, tableCell, tableHeader, tableHeaderCell, tableRow, text, verbatimLink, verbatimSource, verbatimText

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

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 Detail

getTitle

public String getTitle()

Specified by:

getTitle in interface org.apache.maven.reporting.MavenReportRenderer

Specified by:

getTitle in class org.apache.maven.reporting.AbstractMavenReportRenderer

renderBody

protected void renderBody()

Specified by:

renderBody in class org.apache.maven.reporting.AbstractMavenReportRenderer

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

setTreeWalkerNames

public void setTreeWalkerNames(List<String> treeWalkerNames)

sortConfiguration

public List<org.apache.maven.plugins.checkstyle.CheckstyleReportRenderer.ConfReference> sortConfiguration(CheckstyleResults results)