Overview  Package   Class  Deprecated  Index  Help 
Groovy Documentation
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD DETAIL: FIELD | PROPERTY | CONSTR | METHOD

groovy.org.codenarc.report
[Groovy] Class TextReportWriter

java.lang.Object
  groovy.org.codenarc.report.AbstractReportWriter
      groovy.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

Field Summary
 
Fields inherited from class AbstractReportWriter
BASE_MESSAGES_BUNDLE, CODENARC_URL, CUSTOM_MESSAGES_BUNDLE, VERSION_FILE, customMessagesBundleName, getTimestamp, initializeResourceBundle, resourceBundle
 
Property Summary
String defaultOutputFile

int maxPriority

String title

 
Method Summary
protected String getViolationLocationString(Violation violation, String path)

protected void writeFileViolations(Writer writer, FileResults results)

protected void writeFooter(Writer writer)

protected void writePackageViolations(Writer writer, Results results)

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

protected void writeSummary(Writer writer, Results results)

protected void writeTitle(Writer writer)

protected void writeViolation(Writer writer, Violation violation, String path)

 
Methods inherited from class AbstractReportWriter
getCodeNarcVersion, getDescriptionForRule, getFormattedTimestamp, getHtmlDescriptionForRule, getResourceBundleString, getSortedRules, initializeDefaultResourceBundle, isEnabled, writeReport, writeReport
 

Property Detail

defaultOutputFile

String defaultOutputFile

maxPriority

int maxPriority

title

String title

 
Method Detail

getViolationLocationString

@SuppressWarnings('UnusedMethodParameter')
protected String getViolationLocationString(Violation violation, String path)

writeFileViolations

protected void writeFileViolations(Writer writer, FileResults results)

writeFooter

protected void writeFooter(Writer writer)

writePackageViolations

protected void writePackageViolations(Writer writer, Results results)

writeReport

@Override
void writeReport(Writer writer, AnalysisContext analysisContext, Results results)

writeSummary

protected void writeSummary(Writer writer, Results results)

writeTitle

protected void writeTitle(Writer writer)

writeViolation

protected void writeViolation(Writer writer, Violation violation, String path)

 

Groovy Documentation