public class CheckstyleReportGenerator extends Object
Constructor and Description |
---|
CheckstyleReportGenerator(org.apache.maven.doxia.sink.Sink sink,
ResourceBundle bundle,
File basedir,
org.apache.maven.doxia.tools.SiteTool siteTool,
String ruleset) |
Modifier and Type | Method and Description |
---|---|
void |
generateReport(CheckstyleResults results) |
com.puppycrawl.tools.checkstyle.api.Configuration |
getCheckstyleConfig() |
org.apache.maven.plugin.logging.Log |
getLog() |
com.puppycrawl.tools.checkstyle.api.SeverityLevel |
getSeverityLevel() |
List<File> |
getTestSourceDirectories() |
List<String> |
getTreeWalkerNames() |
String |
getXrefLocation() |
String |
getXrefTestLocation() |
boolean |
isEnableFilesSummary() |
boolean |
isEnableRSS()
Deprecated.
|
boolean |
isEnableRulesSummary() |
boolean |
isEnableSeveritySummary() |
boolean |
matchRule(com.puppycrawl.tools.checkstyle.api.AuditEvent event,
String ruleName,
String expectedMessage,
String expectedSeverity)
Check if a violation matches a rule.
|
void |
setCheckstyleConfig(com.puppycrawl.tools.checkstyle.api.Configuration config) |
void |
setEnableFilesSummary(boolean enableFilesSummary) |
void |
setEnableRSS(boolean enableRSS)
Deprecated.
|
void |
setEnableRulesSummary(boolean enableRulesSummary) |
void |
setEnableSeveritySummary(boolean enableSeveritySummary) |
void |
setLog(org.apache.maven.plugin.logging.Log log) |
void |
setSeverityLevel(com.puppycrawl.tools.checkstyle.api.SeverityLevel severityLevel) |
void |
setTestSourceDirectories(List<File> testSourceDirectories) |
void |
setTreeWalkerNames(List<String> treeWalkerNames) |
void |
setXrefLocation(String xrefLocation) |
void |
setXrefTestLocation(String xrefTestLocation) |
List<org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator.ConfReference> |
sortConfiguration(CheckstyleResults results) |
public CheckstyleReportGenerator(org.apache.maven.doxia.sink.Sink sink, ResourceBundle bundle, File basedir, org.apache.maven.doxia.tools.SiteTool siteTool, String ruleset)
public org.apache.maven.plugin.logging.Log getLog()
public void setLog(org.apache.maven.plugin.logging.Log log)
public void generateReport(CheckstyleResults results)
public boolean matchRule(com.puppycrawl.tools.checkstyle.api.AuditEvent event, String ruleName, String expectedMessage, String expectedSeverity)
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 violationpublic com.puppycrawl.tools.checkstyle.api.SeverityLevel getSeverityLevel()
public void setSeverityLevel(com.puppycrawl.tools.checkstyle.api.SeverityLevel severityLevel)
public boolean isEnableRulesSummary()
public void setEnableRulesSummary(boolean enableRulesSummary)
public boolean isEnableSeveritySummary()
public void setEnableSeveritySummary(boolean enableSeveritySummary)
public boolean isEnableFilesSummary()
public void setEnableFilesSummary(boolean enableFilesSummary)
@Deprecated public boolean isEnableRSS()
@Deprecated public void setEnableRSS(boolean enableRSS)
public String getXrefLocation()
public void setXrefLocation(String xrefLocation)
public String getXrefTestLocation()
public void setXrefTestLocation(String xrefTestLocation)
public com.puppycrawl.tools.checkstyle.api.Configuration getCheckstyleConfig()
public void setCheckstyleConfig(com.puppycrawl.tools.checkstyle.api.Configuration config)
public List<org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator.ConfReference> sortConfiguration(CheckstyleResults results)
Copyright © 2005–2022 The Apache Software Foundation. All rights reserved.