Class AbstractReportWriter

java.lang.Object
org.codenarc.report.AbstractReportWriter
All Implemented Interfaces:
groovy.lang.GroovyObject, ReportWriter
Direct Known Subclasses:
AbstractHtmlReportWriter, BaselineXmlReportWriter, TextReportWriter, XmlReportWriter
public abstract class AbstractReportWriter extends Object implements ReportWriter, groovy.lang.GroovyObject

  • Field Details

    • BASE_MESSAGES_BUNDLE

      protected static final String BASE_MESSAGES_BUNDLE
      See Also:

    • CUSTOM_MESSAGES_BUNDLE

      protected static final String CUSTOM_MESSAGES_BUNDLE
      See Also:

    • VERSION_FILE

      protected static final String VERSION_FILE
      See Also:

    • CODENARC_URL

      protected static final String CODENARC_URL
      See Also:

    • getTimestamp

      protected groovy.lang.Closure getTimestamp

    • customMessagesBundleName

      protected String customMessagesBundleName

    • resourceBundle

      protected ResourceBundle resourceBundle

    • initializeResourceBundle

      protected groovy.lang.Closure initializeResourceBundle

  • Constructor Details

    • AbstractReportWriter

      public AbstractReportWriter()

  • Method Details

    • getResourceBundleString

      protected String getResourceBundleString(String resourceKey, String defaultString)

    • getResourceBundleString

      protected String getResourceBundleString(String resourceKey)

    • getMetaClass

      public groovy.lang.MetaClass getMetaClass()
      Specified by:
      getMetaClass in interface groovy.lang.GroovyObject

    • setMetaClass

      public void setMetaClass(groovy.lang.MetaClass mc)
      Specified by:
      setMetaClass in interface groovy.lang.GroovyObject

    • invokeMethod

      public Object invokeMethod(String method, Object arguments)
      Specified by:
      invokeMethod in interface groovy.lang.GroovyObject

    • getProperty

      public Object getProperty(String property)
      Specified by:
      getProperty in interface groovy.lang.GroovyObject

    • setProperty

      public void setProperty(String property, Object value)
      Specified by:
      setProperty in interface groovy.lang.GroovyObject

    • getOutputFile

      public String getOutputFile()

    • setOutputFile

      public void setOutputFile(String value)

    • getWriteToStandardOut

      public Object getWriteToStandardOut()

    • setWriteToStandardOut

      public void setWriteToStandardOut(Object value)

    • writeReport

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

    • writeReport

      public void writeReport(AnalysisContext analysisContext, Results results)
      Specified by:
      writeReport in interface ReportWriter

    • initializeDefaultResourceBundle

      protected void initializeDefaultResourceBundle()

    • getHtmlDescriptionForRule

      protected String getHtmlDescriptionForRule(Rule rule)

    • getDescriptionForRule

      protected String getDescriptionForRule(Rule rule)

    • getResourceBundleString

      protected String getResourceBundleString(String resourceKey, String defaultString, boolean logWarning)

    • getFormattedTimestamp

      protected String getFormattedTimestamp()

    • getSortedRules

      protected List getSortedRules(AnalysisContext analysisContext)

    • isEnabled

      protected boolean isEnabled(Rule rule)

    • getCodeNarcVersion

      protected String getCodeNarcVersion()