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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
private static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final com.puppycrawl.tools.checkstyle.api.Configuration
private final boolean
private final boolean
private final boolean
private final org.codehaus.plexus.i18n.I18N
private final Locale
private static final int
private final org.apache.maven.project.MavenProject
private final CheckstyleResults
private final String
private final org.apache.maven.doxia.tools.SiteTool
private static final int
private static final int
private static final int
private String
private String
Fields inherited from class org.apache.maven.reporting.AbstractMavenReportRenderer
sink
-
Constructor Summary
ConstructorsConstructorDescriptionCheckstyleReportRenderer
(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 TypeMethodDescriptionprivate String
Get the effective Checkstyle version at runtime.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.private String
getEffectiveXrefLocation
(List<com.puppycrawl.tools.checkstyle.api.AuditEvent> eventList) private String
getI18nString
(String key) getTitle()
private void
iconSeverity
(String level, int textType) Render an icon of given level with associated text.private boolean
isTestSource
(String absoluteFilename) boolean
matchRule
(com.puppycrawl.tools.checkstyle.api.AuditEvent event, String ruleName, String expectedMessage, String expectedSeverity) Check if a violation matches a rule.protected void
private void
private void
renderFileEvents
(List<com.puppycrawl.tools.checkstyle.api.AuditEvent> eventList, String filename) private void
private void
renderRuleRow
(CheckstyleReportRenderer.ConfReference ref, CheckstyleResults results, String previousCategory) Create a summary for one Checkstyle rule.private void
Create the rules summary section of the report.private void
void
setTreeWalkerNames
(List<String> treeWalkerNames) 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) 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
-
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
-
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
-
xrefTestLocation
-
testSourceDirectories
-
treeWalkerNames
-
ruleset
-
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
- Specified by:
getTitle
in interfaceorg.apache.maven.reporting.MavenReportRenderer
- Specified by:
getTitle
in classorg.apache.maven.reporting.AbstractMavenReportRenderer
-
getI18nString
- Parameters:
key
- The key.- Returns:
- The translated string.
-
renderBody
protected void renderBody()- Specified by:
renderBody
in classorg.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 configurationparentConfiguration
- The configuration of the parent of the current configurationattributeName
- The name of the attributedefaultValue
- 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 rowresults
- The results to summarizepreviousCategory
- 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 checkruleName
- The name of the ruleexpectedMessage
- A message that, if it's not null, will be matched to the message from the violationexpectedSeverity
- 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
-
getEffectiveXrefLocation
-
isTestSource
-
setTreeWalkerNames
-
iconSeverity
Render an icon of given level with associated text.- Parameters:
level
- one ofINFO
,WARNING
orERROR
constantstextType
- one ofNO_TEXT
,TEXT_SIMPLE
,TEXT_TITLE
orTEXT_ABBREV
constants
-
getCheckstyleVersion
Get the effective Checkstyle version at runtime.- Returns:
- the MANIFEST implementation version of Checkstyle API package (can be
null
)
-
sortConfiguration
-
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)
-