org.apache.maven.plugin.checkstyle
Class CheckstyleReportGenerator

java.lang.Object
  org.apache.maven.plugin.checkstyle.CheckstyleReportGenerator

public class CheckstyleReportGenerator
extends Object

Generate a report based on CheckstyleResults.

Version:

$Id: CheckstyleReportGenerator.java 1653380 2015-01-20 21:51:36Z hboutemy $

CheckstyleReportGenerator

public CheckstyleReportGenerator(Sink sink,
                                 ResourceBundle bundle,
                                 File basedir,
                                 SiteTool siteTool,
                                 String ruleset)

getLog

public Log getLog()

setLog

public void setLog(Log log)

generateReport

public void generateReport(CheckstyleResults results)

matchRule

public boolean matchRule(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

getSeverityLevel

public SeverityLevel getSeverityLevel()

setSeverityLevel

public void setSeverityLevel(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 Configuration getCheckstyleConfig()

setCheckstyleConfig

public void setCheckstyleConfig(Configuration config)

setTreeWalkerNames

public void setTreeWalkerNames(List<String> treeWalkerNames)

getTreeWalkerNames

public List<String> getTreeWalkerNames()

sortConfiguration

public List<org.apache.maven.plugin.checkstyle.CheckstyleReportGenerator.ConfReference> sortConfiguration(CheckstyleResults results)