TextReportWriter (CodeNarc 3.1.0 API)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

org.codenarc.report.TextReportWriter

```
class TextReportWriter
extends AbstractReportWriter
```
ReportWriter that generates an simple ASCII text report. 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

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
`java.lang.String`	`defaultOutputFile`
`int`	`maxPriority`
`java.lang.String`	`title`

Constructor Summary

Constructors
Constructor and description
`TextReportWriter ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected java.lang.String`	`getViolationLocationString(Violation violation, java.lang.String path)`
	`protected void`	`writeFileViolations(java.io.Writer writer, FileResults results)`
	`protected void`	`writeFooter(java.io.Writer writer)`
	`protected void`	`writePackageViolations(java.io.Writer writer, Results results)`
	`void`	`writeReport(java.io.Writer writer, AnalysisContext analysisContext, Results results)`
	`protected void`	`writeSummary(java.io.Writer writer, Results results)`
	`protected void`	`writeTitle(java.io.Writer writer)`
	`protected void`	`writeViolation(java.io.Writer writer, Violation violation, java.lang.String path)`

Inherited Methods Summary

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

- Property Detail
  - java.lang.String defaultOutputFile
  - int maxPriority
  - java.lang.String title
- Constructor Detail
  - TextReportWriter()
- Method Detail
  - @java.lang.SuppressWarnings(value: UnusedMethodParameter) protected java.lang.String getViolationLocationString(Violation violation, java.lang.String path)
  - protected void writeFileViolations(java.io.Writer writer, FileResults results)
  - protected void writeFooter(java.io.Writer writer)
  - protected void writePackageViolations(java.io.Writer writer, Results results)
  - @java.lang.Override void writeReport(java.io.Writer writer, AnalysisContext analysisContext, Results results)
  - protected void writeSummary(java.io.Writer writer, Results results)
  - protected void writeTitle(java.io.Writer writer)
  - protected void writeViolation(java.io.Writer writer, Violation violation, java.lang.String path)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation