|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD | DETAIL: FIELD | PROPERTY | CONSTR | METHOD |
java.lang.Objectorg.codenarc.report.AbstractReportWriter
class AbstractReportWriter
Abstract superclass for ReportWriter implementation classes.
Subclasses must implement thewriteReport(ResultsNode, MetricSet, Writer)
method
and define a defaultOutputFile
property.
Property Summary | |
---|---|
protected static def |
BASE_MESSAGES_BUNDLE
|
protected static def |
CODENARC_URL
|
protected static def |
CUSTOM_MESSAGES_BUNDLE
|
protected def |
LOG
|
protected static def |
VERSION_FILE
|
protected def |
customMessagesBundleName
|
protected def |
getTimestamp
|
protected def |
initializeResourceBundle
|
String |
outputFile
|
protected def |
resourceBundle
|
Object |
writeToStandardOut
|
Constructor Summary | |
AbstractReportWriter()
|
Method Summary | |
---|---|
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 |
Methods inherited from class Object | |
---|---|
wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll |
Property Detail |
---|
protected static final def BASE_MESSAGES_BUNDLE
protected static final def CODENARC_URL
protected static final def CUSTOM_MESSAGES_BUNDLE
protected final def LOG
protected static final def VERSION_FILE
protected def customMessagesBundleName
protected def getTimestamp
protected def initializeResourceBundle
String outputFile
protected def resourceBundle
Object writeToStandardOut
Constructor Detail |
---|
AbstractReportWriter()
Method Detail |
---|
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)
public void writeReport(Writer writer, AnalysisContext analysisContext, Results results)
void writeReport(AnalysisContext analysisContext, Results results)
Groovy Documentation