Package net.sourceforge.pmd.renderers

Class AbstractIncrementingRenderer

java.lang.Object

net.sourceforge.pmd.properties.AbstractPropertySource

net.sourceforge.pmd.renderers.AbstractRenderer

net.sourceforge.pmd.renderers.AbstractIncrementingRenderer

All Implemented Interfaces:

PropertySource, Renderer

Direct Known Subclasses:

CodeClimateRenderer, CSVRenderer, EmacsRenderer, HTMLRenderer, IDEAJRenderer, JsonRenderer, SarifRenderer, TextPadRenderer, TextRenderer, VBHTMLRenderer, XMLRenderer

public abstract class AbstractIncrementingRenderer
extends AbstractRenderer

Abstract base class for 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.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Report.ConfigurationError>	configErrors	Accumulated configuration errors.
protected List<Report.ProcessingError>	errors	Accumulated processing errors.
protected List<Report.SuppressedViolation>	suppressed	Accumulated suppressed violations.

Fields inherited from class net.sourceforge.pmd.renderers.AbstractRenderer

description, name, showSuppressedViolations, writer

Fields inherited from class net.sourceforge.pmd.properties.AbstractPropertySource

propertyDescriptors, propertyValuesByDescriptor

Constructor Summary

Constructors

Constructor	Description
AbstractIncrementingRenderer(String name, String description)

Method Summary

Modifier and Type	Method	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(TextFile dataSource)	This method is called each time a source file is processed.

Methods inherited from class net.sourceforge.pmd.renderers.AbstractRenderer

determineFileName, flush, getDescription, getName, getPropertySourceType, getWriter, isShowSuppressedViolations, setDescription, setFileNameRenderer, setName, setReportFile, setShowSuppressedViolations, setWriter

Methods inherited from class net.sourceforge.pmd.properties.AbstractPropertySource

copyPropertyDescriptors, copyPropertyValues, definePropertyDescriptor, equals, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, hashCode, isPropertyOverridden, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.pmd.properties.PropertySource

definePropertyDescriptor, dysfunctionReason, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, isPropertyOverridden, setProperty

Methods inherited from interface net.sourceforge.pmd.renderers.Renderer

defaultFileExtension, newListener

Field Detail

errors

protected List<Report.ProcessingError> errors

Accumulated processing errors.

configErrors

protected List<Report.ConfigurationError> configErrors

Accumulated configuration errors.

suppressed

protected List<Report.SuppressedViolation> suppressed

Accumulated suppressed violations.

Constructor Detail

AbstractIncrementingRenderer

public AbstractIncrementingRenderer(String name,
                                    String description)

Method Detail

start

public void start()
           throws IOException

Description copied from interface: Renderer

This method is called before any source files are processed. The Renderer will have been fully initialized by the time this method is called, so the Writer and other state will be available.

Throws:

IOException

startFileAnalysis

public void startFileAnalysis(TextFile dataSource)

Description copied from interface: Renderer

This method is called each time a source file is processed. It is called after 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.

Parameters:

dataSource - The source file.

renderFileReport

public void renderFileReport(Report report)
                      throws IOException

Description copied from interface: Renderer

Render the given file Report. There may be multiple Report instances which need to be rendered if produced by different threads. It is called after Renderer.start() and Renderer.startFileAnalysis(TextFile), but before Renderer.end().

Parameters:

report - A file Report.

Throws:

IOException

See Also:

Report

renderFileViolations

public abstract void renderFileViolations(Iterator<RuleViolation> violations)
                                   throws IOException

Render a series of RuleViolations.

Parameters:

violations - The iterator of violations to render.

Throws:

IOException

end

public void end()
         throws IOException

Description copied from interface: Renderer

This method is at the very end of the Rendering process, after Renderer.renderFileReport(Report).

Throws:

IOException