Package org.apache.maven.plugins.checkstyle

Class CheckstyleReportGenerator

java.lang.Object

org.apache.maven.plugins.checkstyle.CheckstyleReportGenerator

public class CheckstyleReportGenerator
extends java.lang.Object

Generate a report based on CheckstyleResults.

Constructor Summary

Constructors

Constructor	Description
CheckstyleReportGenerator(Sink sink, java.util.ResourceBundle bundle, java.io.File basedir, SiteTool siteTool, java.lang.String ruleset)

Method Summary

Modifier and Type	Method	Description
void	generateReport(CheckstyleResults results)
Configuration	getCheckstyleConfig()
Log	getLog()
SeverityLevel	getSeverityLevel()
java.util.List<java.lang.String>	getTreeWalkerNames()
java.lang.String	getXrefLocation()
boolean	isEnableFilesSummary()
boolean	isEnableRSS()
boolean	isEnableRulesSummary()
boolean	isEnableSeveritySummary()
boolean	matchRule(AuditEvent event, java.lang.String ruleName, java.lang.String expectedMessage, java.lang.String expectedSeverity)	Check if a violation matches a rule.
void	setCheckstyleConfig(Configuration config)
void	setEnableFilesSummary(boolean enableFilesSummary)
void	setEnableRSS(boolean enableRSS)
void	setEnableRulesSummary(boolean enableRulesSummary)
void	setEnableSeveritySummary(boolean enableSeveritySummary)
void	setLog(Log log)
void	setSeverityLevel(SeverityLevel severityLevel)
void	setTreeWalkerNames(java.util.List<java.lang.String> treeWalkerNames)
void	setXrefLocation(java.lang.String xrefLocation)
java.util.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(Sink sink,
                                 java.util.ResourceBundle bundle,
                                 java.io.File basedir,
                                 SiteTool siteTool,
                                 java.lang.String ruleset)

Method Detail

getLog

public Log getLog()

setLog

public void setLog(Log log)

generateReport

public void generateReport(CheckstyleResults results)

matchRule

public boolean matchRule(AuditEvent event,
                         java.lang.String ruleName,
                         java.lang.String expectedMessage,
                         java.lang.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 java.lang.String getXrefLocation()

setXrefLocation

public void setXrefLocation(java.lang.String xrefLocation)

getCheckstyleConfig

public Configuration getCheckstyleConfig()

setCheckstyleConfig

public void setCheckstyleConfig(Configuration config)

setTreeWalkerNames

public void setTreeWalkerNames(java.util.List<java.lang.String> treeWalkerNames)

getTreeWalkerNames

public java.util.List<java.lang.String> getTreeWalkerNames()

sortConfiguration

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