Class HtmlReportWriter

java.lang.Object

org.codenarc.report.AbstractReportWriter

org.codenarc.report.AbstractHtmlReportWriter

org.codenarc.report.HtmlReportWriter

All Implemented Interfaces:

groovy.lang.GroovyObject, ReportWriter

public class HtmlReportWriter
extends AbstractHtmlReportWriter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_OUTPUT_FILE

Fields inherited from class AbstractHtmlReportWriter

CSS_FILE, MAX_SOURCE_LINE_LENGTH, SOURCE_LINE_LAST_SEGMENT_LENGTH

Fields inherited from class AbstractReportWriter

BASE_MESSAGES_BUNDLE, CODENARC_URL, CUSTOM_MESSAGES_BUNDLE, customMessagesBundleName, getTimestamp, initializeResourceBundle, resourceBundle, VERSION_FILE

Constructor Summary

Constructors

Constructor	Description
HtmlReportWriter()

Method Summary

Modifier and Type	Method	Description
protected groovy.lang.Closure	buildBodySection(AnalysisContext analysisContext, Results results)
String	getDefaultOutputFile()
boolean	getIncludeSummaryByPackage()
groovy.lang.MetaClass	getMetaClass()
Object	getProperty(String property)
Object	invokeMethod(String method, Object arguments)
boolean	isIncludeSummaryByPackage()
void	setDefaultOutputFile(String value)
void	setIncludeSummaryByPackage(boolean value)
void	setMetaClass(groovy.lang.MetaClass mc)
void	setProperty(String property, Object value)
String	toString()

Methods inherited from class AbstractHtmlReportWriter

buildCSS, buildHeaderSection, buildLogo, buildReportMetadata, buildRuleDescriptions, buildScript, buildTitle, formatSourceLine, formatSourceLine, getCssFile, getIncludeRuleDescriptions, getMaxPriority, getTitle, isDirectoryContainingFiles, isDirectoryContainingFilesWithViolations, isIncludeRuleDescriptions, setIncludeRuleDescriptions, setMaxPriority, setTitle, writeReport

Methods inherited from class AbstractReportWriter

getCodeNarcVersion, getDescriptionForRule, getFormattedTimestamp, getHtmlDescriptionForRule, getOutputFile, getResourceBundleString, getResourceBundleString, getResourceBundleString, getSortedRules, getWriteToStandardOut, initializeDefaultResourceBundle, isEnabled, setOutputFile, setWriteToStandardOut, writeReport

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_OUTPUT_FILE

public static final String DEFAULT_OUTPUT_FILE

See Also:

• Constant Field Values

Constructor Details

HtmlReportWriter

public HtmlReportWriter()

Method Details

getMetaClass

public groovy.lang.MetaClass getMetaClass()

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

Overrides:

getMetaClass in class AbstractHtmlReportWriter

setMetaClass

public void setMetaClass(groovy.lang.MetaClass mc)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject

Overrides:

setMetaClass in class AbstractHtmlReportWriter

invokeMethod

public Object invokeMethod(String method,
 Object arguments)

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

Overrides:

invokeMethod in class AbstractHtmlReportWriter

getProperty

public Object getProperty(String property)

Specified by:

getProperty in interface groovy.lang.GroovyObject

Overrides:

getProperty in class AbstractHtmlReportWriter

setProperty

public void setProperty(String property,
 Object value)

Specified by:

setProperty in interface groovy.lang.GroovyObject

Overrides:

setProperty in class AbstractHtmlReportWriter

getDefaultOutputFile

public String getDefaultOutputFile()

setDefaultOutputFile

public void setDefaultOutputFile(String value)

getIncludeSummaryByPackage

public boolean getIncludeSummaryByPackage()

isIncludeSummaryByPackage

public boolean isIncludeSummaryByPackage()

setIncludeSummaryByPackage

public void setIncludeSummaryByPackage(boolean value)

toString

public String toString()

Overrides:

toString in class Object

buildBodySection

protected groovy.lang.Closure buildBodySection(AnalysisContext analysisContext,
 Results results)

Specified by:

buildBodySection in class AbstractHtmlReportWriter