Groovy Documentation

org.codenarc.report
[Groovy] Class HtmlReportWriter

java.lang.Object
  org.codenarc.report.AbstractReportWriter
      org.codenarc.report.HtmlReportWriter

@SuppressWarnings(['DuplicateLiteral', 'UnnecessaryReturnKeyword'])
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=..."

Authors:
Chris Mair
Version:
\$Revision: 613 \$ - \$Date: 2011-02-25 15:19:57 -0500 (Fri, 25 Feb 2011) \$


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

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

Field Detail

DEFAULT_OUTPUT_FILE

public static final def DEFAULT_OUTPUT_FILE


 
Property Detail

defaultOutputFile

String defaultOutputFile


title

String title


 
Method Detail

formatSourceLine

protected String formatSourceLine(String sourceLine, int startColumn = 0)
Format and trim the source line. If the whole line fits, then include the whole line (trimmed). Otherwise, remove characters from the middle to truncate to the max length.
Parameters:
sourceLine - - the source line to format
startColumn - - the starting column index; used to truncate the line if it's too long; defaults to 0
Returns:
the formatted and trimmed source line


isDirectoryContainingFiles

protected boolean isDirectoryContainingFiles(Results results)
Return true if the Results represents a directory that contains at least one file
Parameters:
results - - the Results


isDirectoryContainingFilesWithViolations

protected boolean isDirectoryContainingFilesWithViolations(Results results)
Return true if the Results represents a directory that contains at least one file with one or more violations.
Parameters:
results - - the Results


toString

String toString()


writeReport

void writeReport(Writer writer, AnalysisContext analysisContext, Results results)
Write out a report to the specified Writer for the analysis results
Parameters:
analysisContext - - the AnalysisContext containing the analysis configuration information
results - - the analysis results


 

Groovy Documentation