Package net.sourceforge.pmd.renderers

Class SarifRenderer

java.lang.Object

net.sourceforge.pmd.properties.AbstractPropertySource

net.sourceforge.pmd.renderers.AbstractRenderer

net.sourceforge.pmd.renderers.AbstractIncrementingRenderer

net.sourceforge.pmd.renderers.SarifRenderer

All Implemented Interfaces:

PropertySource, Renderer

public class SarifRenderer
extends AbstractIncrementingRenderer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

configErrors, errors, suppressed

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

description, name, showSuppressedViolations, writer

Constructor Summary

Constructors

Constructor	Description
SarifRenderer()

Method Summary

Modifier and Type	Method	Description
String	defaultFileExtension()	Return the default filename extension to use.
void	end()	This method is at the very end of the Rendering process, after Renderer.renderFileReport(Report).
void	renderFileViolations(Iterator<RuleViolation> violations)	Render a series of RuleViolations.
void	setReportFile(String reportFilename)	Sets the filename where the report should be written to.
void	start()	This method is called before any source files are processed.

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

renderFileReport, startFileAnalysis

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

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

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

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

newListener

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

SarifRenderer

public SarifRenderer()

Method Details

defaultFileExtension

public String defaultFileExtension()

Description copied from interface: Renderer

Return the default filename extension to use.

Returns:

String

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.

Specified by:

start in interface Renderer

Overrides:

start in class AbstractIncrementingRenderer

Throws:

IOException

renderFileViolations

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

Description copied from class: AbstractIncrementingRenderer

Render a series of RuleViolations.

Specified by:

renderFileViolations in class AbstractIncrementingRenderer

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).

Specified by:

end in interface Renderer

Overrides:

end in class AbstractIncrementingRenderer

Throws:

IOException

setReportFile

public void setReportFile(String reportFilename)

Description copied from class: AbstractRenderer

Sets the filename where the report should be written to. If no filename is provided, the renderer should write to stdout.

Implementations must initialize the writer of the renderer.

See AbstractRenderer.setReportFile(String) for the default impl.

This default implementation always uses the system default charset for the writer. Overwrite in specific renderers to support other charsets.

Specified by:

setReportFile in interface Renderer

Overrides:

setReportFile in class AbstractRenderer

Parameters:

reportFilename - the filename (optional).