public abstract class AbstractIncrementingRenderer extends AbstractRenderer
Renderer implementations which can produce
output incrementally for RuleViolations as source files are
processed. Such Renderers are able to produce large reports with
significantly less working memory at any given time. Variations in the
delivery of source file reports are reflected in the output of the
Renderer, so report output can be different between runs.
Only processing errors and suppressed violations are accumulated across all
files. These are intended to be processed in the end() method.| Modifier and Type | Field and Description |
|---|---|
protected List<Report.ProcessingError> |
errors
Accumulated processing errors.
|
protected List<Report.SuppressedViolation> |
suppressed
Accumulated suppressed violations.
|
description, name, propertyDefinitions, showSuppressedViolations, writerpropertyDescriptors, propertyValuesByDescriptor| Constructor and Description |
|---|
AbstractIncrementingRenderer(String name,
String description) |
| Modifier and Type | Method and Description |
|---|---|
void |
end()
This method is at the very end of the Rendering process, after
Renderer.renderFileReport(Report). |
void |
renderFileReport(Report report)
Render the given file Report.
|
abstract void |
renderFileViolations(Iterator<RuleViolation> violations)
Render a series of
RuleViolations. |
void |
start()
This method is called before any source files are processed.
|
void |
startFileAnalysis(DataSource dataSource)
This method is called each time a source file is processed.
|
defineProperty, flush, getDescription, getName, getPropertyDefinitions, getWriter, isShowSuppressedViolations, setDescription, setName, setShowSuppressedViolations, setWritercopyPropertyDescriptors, copyPropertyValues, definePropertyDescriptor, dysfunctionReason, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, setProperty, useDefaultValueFor, usesDefaultValuesclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdefaultFileExtensiondefinePropertyDescriptor, dysfunctionReason, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, setProperty, useDefaultValueFor, usesDefaultValuesprotected List<Report.ProcessingError> errors
protected List<Report.SuppressedViolation> suppressed
public void start()
throws IOException
IOExceptionpublic void startFileAnalysis(DataSource dataSource)
Renderer.start(), but before
Renderer.renderFileReport(Report) and Renderer.end().
This method may be invoked by different threads which are processing
files independently. Therefore, any non-trivial implementation of this
method needs to be thread-safe.dataSource - The source file.public void renderFileReport(Report report) throws IOException
Renderer.start() and
Renderer.startFileAnalysis(DataSource), but before Renderer.end().report - A file Report.IOExceptionReportpublic abstract void renderFileViolations(Iterator<RuleViolation> violations) throws IOException
RuleViolations.violations - The iterator of violations to render.IOExceptionpublic void end()
throws IOException
Renderer.renderFileReport(Report).IOExceptionCopyright © 2002-2014 InfoEther. All Rights Reserved.