HtmlReportWriter (CodeNarc 3.0.1 API)

Summary:
Field
Property
Constructor
Method

org.codenarc.report.HtmlReportWriter

```
@java.lang.SuppressWarnings(value: DuplicateMapLiteral)
class HtmlReportWriter
extends AbstractHtmlReportWriter
```
ReportWriter that generates an HTML report.
The default localized messages, including rule descriptions, are read from the "codenarc-base-messages" ResourceBundle. You can override these messages using the normal ResourceBundle mechanisms (i.e. creating a locale-specific resource bundle file on the classpath, such as "codenarc-base-messages_de"). You can optionally add rule descriptions for custom rules by placing them within a "codenarc-messages.properties" file on the classpath, with entries of the form: {rule-name}.description=..."
Set the includeSummaryByPackage property to false to exclude the violation summary for each package within the "Summary" section of the report. It defaults to true.
Set the includeRuleDescriptions property to false to exclude the rule descriptions section of the report. It defaults to true.
Set the maxPriority property to control the maximum priority level for violations in the report. For instance, setting maxPriority to 2 will result in the report containing only priority 1 and 2 violations (and omitting violations with priority 3). The maxPriority property defaults to 3.
Authors:
Chris Mair

Field Summary

Fields
Modifiers	Name	Description
`static java.lang.String`	`DEFAULT_OUTPUT_FILE`

Inherited fields
Fields inherited from class	Fields
`class AbstractHtmlReportWriter`	`CSS_FILE, LOGO_FILE, MAX_SOURCE_LINE_LENGTH, SOURCE_LINE_LAST_SEGMENT_LENGTH`
`class AbstractReportWriter`	`BASE_MESSAGES_BUNDLE, CODENARC_URL, CUSTOM_MESSAGES_BUNDLE, customMessagesBundleName, getTimestamp, initializeResourceBundle, resourceBundle`

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`defaultOutputFile`
`boolean`	`includeSummaryByPackage`

Constructor Summary

Constructors
Constructor and description
`HtmlReportWriter ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected groovy.lang.Closure`	`buildBodySection(AnalysisContext analysisContext, Results results)`
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractHtmlReportWriter`	`buildBodySection, buildCSS, buildHeaderSection, buildLogo, buildReportMetadata, buildRuleDescriptions, buildScript, buildTitle, formatSourceLine, getCssFile, isDirectoryContainingFiles, isDirectoryContainingFilesWithViolations, writeReport`
`class AbstractReportWriter`	`getCodeNarcVersion, getDescriptionForRule, getFormattedTimestamp, getHtmlDescriptionForRule, getResourceBundleString, getSortedRules, initializeDefaultResourceBundle, isEnabled, isWriteToStandardOut, writeReport, writeReport`

- Field Detail
  - public static final java.lang.String DEFAULT_OUTPUT_FILE
- Property Detail
  - java.lang.String defaultOutputFile
  - boolean includeSummaryByPackage
- Constructor Detail
  - HtmlReportWriter()
- Method Detail
  - @java.lang.Override protected groovy.lang.Closure buildBodySection(AnalysisContext analysisContext, Results results)
  - @java.lang.Override java.lang.String toString()

Summary:
Field
Property
Constructor
Method

Groovy Documentation