AbstractHtmlReportWriter (CodeNarc 3.6.0 API)

org.codenarc.report.AbstractHtmlReportWriter

@java.lang.SuppressWarnings(value: DuplicateMapLiteral)
abstract class AbstractHtmlReportWriter
extends AbstractReportWriter

Abstract superclass for HTML ReportWriter classes.

Authors:: Chris Mair

Field Summary

Fields
Modifiers	Name	Description
`protected static java.lang.String`	`CSS_FILE`
`protected static java.lang.String`	`LOGO_FILE`
`protected static int`	`MAX_SOURCE_LINE_LENGTH`
`protected static int`	`SOURCE_LINE_LAST_SEGMENT_LENGTH`

Inherited fields
Fields inherited from class	Fields
`class AbstractReportWriter`	`BASE_MESSAGES_BUNDLE, CODENARC_URL, CUSTOM_MESSAGES_BUNDLE, customMessagesBundleName, getTimestamp, initializeResourceBundle, resourceBundle`

Properties Summary

Properties
Type	Name and description
`boolean`	`includeRuleDescriptions`
`int`	`maxPriority`
`java.lang.String`	`title`

Constructor Summary

Constructors
Constructor and description
`AbstractHtmlReportWriter ()`

Methods Summary

Methods
Type Params	Return Type	Name and 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 java.lang.String`	`buildTitle()`
	`protected java.lang.String`	`formatSourceLine(java.lang.String sourceLine, int startColumn)` Format and trim the source line.
	`protected java.lang.String`	`getCssFile()`
	`protected boolean`	`isDirectoryContainingFiles(Results results)` Return true if the Results represents a directory that contains at least one file
	`protected boolean`	`isDirectoryContainingFilesWithViolations(Results results)` Return true if the Results represents a directory that contains at least one file with one or more violations.
	`void`	`writeReport(java.io.Writer writer, AnalysisContext analysisContext, Results results)` Write out a report to the specified Writer for the analysis results

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractReportWriter`	`getCodeNarcVersion, getDescriptionForRule, getFormattedTimestamp, getHtmlDescriptionForRule, getResourceBundleString, getSortedRules, initializeDefaultResourceBundle, isEnabled, isWriteToStandardOut, writeReport, writeReport`

- Field Detail
  - protected static final java.lang.String CSS_FILE
  - protected static final java.lang.String LOGO_FILE
  - protected static final int MAX_SOURCE_LINE_LENGTH
  - protected static final int SOURCE_LINE_LAST_SEGMENT_LENGTH
- Property Detail
  - boolean includeRuleDescriptions
  - int maxPriority
  - java.lang.String title
- Constructor Detail
  - AbstractHtmlReportWriter()
- Method Detail
  - 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 java.lang.String buildTitle()
  - protected java.lang.String formatSourceLine(java.lang.String sourceLine, int startColumn)
    
    Format and trim the source line. If the whole line fits, then include the whole line (trimmed). Otherwise, remove characters from the middle to truncate to the max length.
    Parameters:
    sourceLine - - the source line to format
    startColumn - - the starting column index; used to truncate the line if it's too long; defaults to 0
    Returns:
    the formatted and trimmed source line
  - protected java.lang.String getCssFile()
  - protected boolean isDirectoryContainingFiles(Results results)
    
    Return true if the Results represents a directory that contains at least one file
    Parameters:
    results - - the Results
  - protected boolean isDirectoryContainingFilesWithViolations(Results results)
    
    Return true if the Results represents a directory that contains at least one file with one or more violations.
    Parameters:
    results - - the Results
  - @java.lang.Override void writeReport(java.io.Writer writer, AnalysisContext analysisContext, Results results)
    
    Write out a report to the specified Writer for the analysis results
    Parameters:
    analysisContext - - the AnalysisContext containing the analysis configuration information
    results - - the analysis results

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractHtmlReportWriter

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected static final java.lang.String CSS_FILE

protected static final java.lang.String LOGO_FILE

protected static final int MAX_SOURCE_LINE_LENGTH

protected static final int SOURCE_LINE_LAST_SEGMENT_LENGTH

Property Detail

boolean includeRuleDescriptions

int maxPriority

java.lang.String title

Constructor Detail

AbstractHtmlReportWriter()

Method Detail

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 java.lang.String buildTitle()

protected java.lang.String formatSourceLine(java.lang.String sourceLine, int startColumn)

protected java.lang.String getCssFile()

protected boolean isDirectoryContainingFiles(Results results)

protected boolean isDirectoryContainingFilesWithViolations(Results results)

@java.lang.Override void writeReport(java.io.Writer writer, AnalysisContext analysisContext, Results results)