|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | PROPERTY | CONSTR | METHOD | DETAIL: FIELD | PROPERTY | CONSTR | METHOD |
java.lang.Objectgroovy.org.codenarc.report.AbstractReportWriter
groovy.org.codenarc.report.HtmlReportWriter
@SuppressWarnings(['DuplicateMapLiteral', 'UnnecessaryReturnKeyword', 'FactoryMethodName']) class HtmlReportWriter extends AbstractReportWriter
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=..."Field Summary | |
---|---|
static def |
DEFAULT_OUTPUT_FILE
|
Fields inherited from class AbstractReportWriter | |
---|---|
BASE_MESSAGES_BUNDLE, CODENARC_URL, CUSTOM_MESSAGES_BUNDLE, VERSION_FILE, customMessagesBundleName, getTimestamp, initializeResourceBundle, resourceBundle |
Property Summary | |
---|---|
String |
defaultOutputFile
|
String |
title
|
Method Summary | |
---|---|
protected String
|
formatSourceLine(String sourceLine, int startColumn = 0)
Format and trim the source line. |
protected boolean
|
isDirectoryContainingFiles(Results results)
Return true if the Results represents a directory that contains at least one file |
protected boolean
|
isDirectoryContainingFilesWithViolations(Results results)
Return true if the Results represents a directory that contains at least one file with one or more violations. |
String
|
toString()
|
void
|
writeReport(Writer writer, AnalysisContext analysisContext, Results results)
Write out a report to the specified Writer for the analysis results |
Field Detail |
---|
public static final def DEFAULT_OUTPUT_FILE
Property Detail |
---|
String defaultOutputFile
String title
Method Detail |
---|
protected String formatSourceLine(String sourceLine, int startColumn = 0)
sourceLine
- - the source line to formatstartColumn
- - the starting column index; used to truncate the line if it's too long; defaults to 0
protected boolean isDirectoryContainingFiles(Results results)
results
- - the Results
protected boolean isDirectoryContainingFilesWithViolations(Results results)
results
- - the Results
String toString()
void writeReport(Writer writer, AnalysisContext analysisContext, Results results)
analysisContext
- - the AnalysisContext containing the analysis configuration informationresults
- - the analysis results
Groovy Documentation