org.codenarc.report

Class TextReportWriter

java.lang.Object

org.codenarc.report.AbstractReportWriter

org.codenarc.report.TextReportWriter

All Implemented Interfaces:

groovy.lang.GroovyObject, ReportWriter

Direct Known Subclasses:

IdeTextReportWriter

public class TextReportWriter
extends AbstractReportWriter

Field Summary

Fields inherited from class org.codenarc.report.AbstractReportWriter

BASE_MESSAGES_BUNDLE, CODENARC_URL, CUSTOM_MESSAGES_BUNDLE, customMessagesBundleName, getTimestamp, initializeResourceBundle, resourceBundle, VERSION_FILE

Constructor Summary

Constructors

Constructor and Description
TextReportWriter()

Method Summary

Modifier and Type	Method and Description
String	getDefaultOutputFile()
int	getMaxPriority()
groovy.lang.MetaClass	getMetaClass()
Object	getProperty(String property)
String	getTitle()
protected String	getViolationLocationString(Violation violation, String path)
Object	invokeMethod(String method, Object arguments)
void	setDefaultOutputFile(String value)
void	setMaxPriority(int value)
void	setMetaClass(groovy.lang.MetaClass mc)
void	setProperty(String property, Object value)
void	setTitle(String value)
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 org.codenarc.report.AbstractReportWriter

getCodeNarcVersion, getDescriptionForRule, getFormattedTimestamp, getHtmlDescriptionForRule, getOutputFile, getResourceBundleString, getResourceBundleString, getResourceBundleString, getSortedRules, getWriteToStandardOut, initializeDefaultResourceBundle, isEnabled, setOutputFile, setWriteToStandardOut, writeReport

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextReportWriter

public TextReportWriter()

Method Detail

getMetaClass

public groovy.lang.MetaClass getMetaClass()

Specified by:

getMetaClass in interface groovy.lang.GroovyObject

Overrides:

getMetaClass in class AbstractReportWriter

setMetaClass

public void setMetaClass(groovy.lang.MetaClass mc)

Specified by:

setMetaClass in interface groovy.lang.GroovyObject

Overrides:

setMetaClass in class AbstractReportWriter

invokeMethod

public Object invokeMethod(String method,
                           Object arguments)

Specified by:

invokeMethod in interface groovy.lang.GroovyObject

Overrides:

invokeMethod in class AbstractReportWriter

getProperty

public Object getProperty(String property)

Specified by:

getProperty in interface groovy.lang.GroovyObject

Overrides:

getProperty in class AbstractReportWriter

setProperty

public void setProperty(String property,
                        Object value)

Specified by:

setProperty in interface groovy.lang.GroovyObject

Overrides:

setProperty in class AbstractReportWriter

getTitle

public String getTitle()

setTitle

public void setTitle(String value)

getDefaultOutputFile

public String getDefaultOutputFile()

setDefaultOutputFile

public void setDefaultOutputFile(String value)

getMaxPriority

public int getMaxPriority()

setMaxPriority

public void setMaxPriority(int value)

writeReport

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

Specified by:

writeReport in class AbstractReportWriter

writeTitle

protected void writeTitle(Writer writer)

writeSummary

protected void writeSummary(Writer writer,
                            Results results)

writePackageViolations

protected void writePackageViolations(Writer writer,
                                      Results results)

writeFileViolations

protected void writeFileViolations(Writer writer,
                                   FileResults results)

writeViolation

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

getViolationLocationString

protected String getViolationLocationString(Violation violation,
                                            String path)

writeFooter

protected void writeFooter(Writer writer)