abstract class AbstractReportWriter
Abstract superclass for ReportWriter implementation classes.
Subclasses must implement thewriteReport(ResultsNode, MetricSet, Writer)
method
and define a defaultOutputFile
property.
Modifiers | Name | Description |
---|---|---|
protected static def |
BASE_MESSAGES_BUNDLE |
|
protected static def |
CODENARC_URL |
|
protected static def |
CUSTOM_MESSAGES_BUNDLE |
|
protected static def |
VERSION_FILE |
|
protected def |
customMessagesBundleName |
|
protected def |
getTimestamp |
|
protected def |
initializeResourceBundle |
|
protected def |
resourceBundle |
Type | Name and description |
---|---|
String |
outputFile |
Object |
writeToStandardOut |
Type Params | Return Type | Name and description |
---|---|---|
|
protected String |
getCodeNarcVersion() |
|
protected String |
getDescriptionForRule(Rule rule) |
|
protected String |
getFormattedTimestamp() |
|
protected String |
getHtmlDescriptionForRule(Rule rule) |
|
protected String |
getResourceBundleString(String resourceKey, String defaultString = '?', boolean logWarning = true) |
|
protected List |
getSortedRules(AnalysisContext analysisContext) |
|
protected void |
initializeDefaultResourceBundle() |
|
protected boolean |
isEnabled(Rule rule) |
|
void |
writeReport(Writer writer, AnalysisContext analysisContext, Results results) |
|
void |
writeReport(AnalysisContext analysisContext, Results results) Write out a report for the specified analysis results |
Write out a report for the specified analysis results
analysisContext
- - the AnalysisContext containing the analysis configuration informationresults
- - the analysis results