Groovy Documentation

groovy.org.codenarc.report
[Groovy] Class AbstractReportWriter

java.lang.Object
  groovy.org.codenarc.report.AbstractReportWriter
All Implemented Interfaces:
ReportWriter

abstract class AbstractReportWriter

Abstract superclass for ReportWriter implementation classes.

Subclasses must implement the writeReport(ResultsNode, MetricSet, Writer) method and define a defaultOutputFile property.

Authors:
Chris Mair


Field Summary
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

 
Property Summary
String outputFile

Object writeToStandardOut

 
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
 

Field Detail

BASE_MESSAGES_BUNDLE

protected static final def BASE_MESSAGES_BUNDLE


CODENARC_URL

protected static final def CODENARC_URL


CUSTOM_MESSAGES_BUNDLE

protected static final def CUSTOM_MESSAGES_BUNDLE


VERSION_FILE

protected static final def VERSION_FILE


customMessagesBundleName

protected def customMessagesBundleName


getTimestamp

protected def getTimestamp


initializeResourceBundle

protected def initializeResourceBundle


resourceBundle

protected def resourceBundle


 
Property Detail

outputFile

String outputFile


writeToStandardOut

Object writeToStandardOut


 
Method Detail

getCodeNarcVersion

protected String getCodeNarcVersion()


getDescriptionForRule

protected String getDescriptionForRule(Rule rule)


getFormattedTimestamp

protected String getFormattedTimestamp()


getHtmlDescriptionForRule

protected String getHtmlDescriptionForRule(Rule rule)


getResourceBundleString

protected String getResourceBundleString(String resourceKey, String defaultString = '?', boolean logWarning = true)


getSortedRules

protected List getSortedRules(AnalysisContext analysisContext)


initializeDefaultResourceBundle

protected void initializeDefaultResourceBundle()


isEnabled

protected boolean isEnabled(Rule rule)


writeReport

void writeReport(Writer writer, AnalysisContext analysisContext, Results results)


writeReport

void writeReport(AnalysisContext analysisContext, Results results)
Write out a report for the specified analysis results
Parameters:
analysisContext - - the AnalysisContext containing the analysis configuration information
results - - the analysis results


 

Groovy Documentation