Package org.codenarc.report

Class AbstractHtmlReportWriter

java.lang.Object

org.codenarc.report.AbstractReportWriter

org.codenarc.report.AbstractHtmlReportWriter

All Implemented Interfaces:

groovy.lang.GroovyObject, ReportWriter

Direct Known Subclasses:

HtmlReportWriter, SortableHtmlReportWriter

public abstract class AbstractHtmlReportWriter
extends AbstractReportWriter

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	CSS_FILE
protected static int	MAX_SOURCE_LINE_LENGTH
protected static int	SOURCE_LINE_LAST_SEGMENT_LENGTH

Fields inherited from class org.codenarc.report.AbstractReportWriter

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

Constructor Summary

Constructors

Constructor	Description
AbstractHtmlReportWriter()

Method Summary

Modifier and Type	Method	Description
protected abstract groovy.lang.Closure	buildBodySection(AnalysisContext analysisContext, Results results)
protected groovy.lang.Closure	buildCSS()
protected groovy.lang.Closure	buildHeaderSection()
protected groovy.lang.Closure	buildLogo()
protected groovy.lang.Closure	buildReportMetadata()
protected groovy.lang.Closure	buildRuleDescriptions(AnalysisContext analysisContext)
protected groovy.lang.Closure	buildScript()
protected String	buildTitle()
protected String	formatSourceLine(String sourceLine)
protected String	formatSourceLine(String sourceLine, int startColumn)
protected String	getCssFile()
boolean	getIncludeRuleDescriptions()
int	getMaxPriority()
groovy.lang.MetaClass	getMetaClass()
Object	getProperty(String property)
String	getTitle()
Object	invokeMethod(String method, Object arguments)
protected boolean	isDirectoryContainingFiles(Results results)
protected boolean	isDirectoryContainingFilesWithViolations(Results results)
boolean	isIncludeRuleDescriptions()
void	setIncludeRuleDescriptions(boolean value)
void	setMaxPriority(int value)
void	setMetaClass(groovy.lang.MetaClass mc)
void	setProperty(String property, Object value)
void	setTitle(String value)
void	writeReport(Writer writer, AnalysisContext analysisContext, Results results)

Methods inherited from class org.codenarc.report.AbstractReportWriter

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

Methods inherited from class java.lang.Object

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

Field Detail

MAX_SOURCE_LINE_LENGTH

protected static final int MAX_SOURCE_LINE_LENGTH

See Also:

Constant Field Values

SOURCE_LINE_LAST_SEGMENT_LENGTH

protected static final int SOURCE_LINE_LAST_SEGMENT_LENGTH

See Also:

Constant Field Values

CSS_FILE

protected static final String CSS_FILE

See Also:

Constant Field Values

Constructor Detail

AbstractHtmlReportWriter

public AbstractHtmlReportWriter()

Method Detail

formatSourceLine

protected String formatSourceLine(String sourceLine)

getMetaClass

public groovy.lang.MetaClass getMetaClass()

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

Overrides:

getMetaClass in class AbstractReportWriter

setMetaClass

public void setMetaClass(groovy.lang.MetaClass mc)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject

Overrides:

setMetaClass in class AbstractReportWriter

invokeMethod

public Object invokeMethod(String method,
                           Object arguments)

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

Overrides:

invokeMethod in class AbstractReportWriter

getProperty

public Object getProperty(String property)

Specified by:

getProperty in interface groovy.lang.GroovyObject

Overrides:

getProperty in class AbstractReportWriter

setProperty

public void setProperty(String property,
                        Object value)

Specified by:

setProperty in interface groovy.lang.GroovyObject

Overrides:

setProperty in class AbstractReportWriter

getTitle

public String getTitle()

setTitle

public void setTitle(String value)

getIncludeRuleDescriptions

public boolean getIncludeRuleDescriptions()

isIncludeRuleDescriptions

public boolean isIncludeRuleDescriptions()

setIncludeRuleDescriptions

public void setIncludeRuleDescriptions(boolean value)

getMaxPriority

public int getMaxPriority()

setMaxPriority

public void setMaxPriority(int value)

getCssFile

protected String getCssFile()

buildBodySection

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

writeReport

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

Specified by:

writeReport in class AbstractReportWriter

buildCSS

protected groovy.lang.Closure buildCSS()

buildScript

protected groovy.lang.Closure buildScript()

buildHeaderSection

protected groovy.lang.Closure buildHeaderSection()

buildReportMetadata

protected groovy.lang.Closure buildReportMetadata()

buildLogo

protected groovy.lang.Closure buildLogo()

buildRuleDescriptions

protected groovy.lang.Closure buildRuleDescriptions(AnalysisContext analysisContext)

formatSourceLine

protected String formatSourceLine(String sourceLine,
                                  int startColumn)

isDirectoryContainingFilesWithViolations

protected boolean isDirectoryContainingFilesWithViolations(Results results)

isDirectoryContainingFiles

protected boolean isDirectoryContainingFiles(Results results)

buildTitle

protected String buildTitle()