org.apache.maven.plugins.checkstyle

Class CheckstyleReportGenerator

java.lang.Object

org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator

public class CheckstyleReportGenerator
extends Object

Generate a report based on CheckstyleResults.

Constructor Summary

Constructors

Constructor and Description
CheckstyleReportGenerator(org.apache.maven.doxia.sink.Sink sink, ResourceBundle bundle, File basedir, org.apache.maven.doxia.tools.SiteTool siteTool, String ruleset)

Method Summary

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)

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckstyleReportGenerator

public CheckstyleReportGenerator(org.apache.maven.doxia.sink.Sink sink,
                                 ResourceBundle bundle,
                                 File basedir,
                                 org.apache.maven.doxia.tools.SiteTool siteTool,
                                 String ruleset)

Method Detail

getLog

public org.apache.maven.plugin.logging.Log getLog()

setLog

public void setLog(org.apache.maven.plugin.logging.Log log)

generateReport

public void generateReport(CheckstyleResults results)

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

getSeverityLevel

public com.puppycrawl.tools.checkstyle.api.SeverityLevel getSeverityLevel()

setSeverityLevel

public void setSeverityLevel(com.puppycrawl.tools.checkstyle.api.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

@Deprecated
public boolean isEnableRSS()

Deprecated.

setEnableRSS

@Deprecated
public void setEnableRSS(boolean enableRSS)

Deprecated.

getXrefLocation

public String getXrefLocation()

setXrefLocation

public void setXrefLocation(String xrefLocation)

getXrefTestLocation

public String getXrefTestLocation()

setXrefTestLocation

public void setXrefTestLocation(String xrefTestLocation)

getTestSourceDirectories

public List<File> getTestSourceDirectories()

setTestSourceDirectories

public void setTestSourceDirectories(List<File> testSourceDirectories)

getCheckstyleConfig

public com.puppycrawl.tools.checkstyle.api.Configuration getCheckstyleConfig()

setCheckstyleConfig

public void setCheckstyleConfig(com.puppycrawl.tools.checkstyle.api.Configuration config)

setTreeWalkerNames

public void setTreeWalkerNames(List<String> treeWalkerNames)

getTreeWalkerNames

public List<String> getTreeWalkerNames()

sortConfiguration

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