Groovy Documentation

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

java.lang.Object
  groovy.org.codenarc.report.AbstractReportWriter
      groovy.org.codenarc.report.TextReportWriter
          groovy.org.codenarc.report.IdeTextReportWriter

class IdeTextReportWriter
extends TextReportWriter

ReportWriter that generates an simple ASCII text report, and includes IDE-compatible (Eclipse, Idea) hyperlinks to source code for violations. 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
 
Method Summary
protected String getViolationLocationString(Violation violation, String path)

 
Methods inherited from class TextReportWriter
getViolationLocationString, writeFileViolations, writeFooter, writePackageViolations, writeReport, writeSummary, writeTitle, writeViolation
 
Methods inherited from class AbstractReportWriter
getCodeNarcVersion, getDescriptionForRule, getFormattedTimestamp, getHtmlDescriptionForRule, getResourceBundleString, getSortedRules, initializeDefaultResourceBundle, isEnabled, writeReport, writeReport
 

Method Detail

getViolationLocationString

@Override
protected String getViolationLocationString(Violation violation, String path)


 

Groovy Documentation