Package net.sourceforge.pmd.renderers

Class AbstractRenderer

java.lang.Object

net.sourceforge.pmd.properties.AbstractPropertySource

net.sourceforge.pmd.renderers.AbstractRenderer

All Implemented Interfaces:

PropertySource, Renderer

Direct Known Subclasses:

AbstractAccumulatingRenderer, AbstractIncrementingRenderer, EmptyRenderer

public abstract class AbstractRenderer
extends AbstractPropertySource
implements Renderer

Abstract base class for Renderer implementations.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description
protected String	name
protected boolean	showSuppressedViolations
protected PrintWriter	writer

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

propertyDescriptors, propertyValuesByDescriptor

Constructor Summary

Constructors

Constructor	Description
AbstractRenderer(String name, String description)

Method Summary

Modifier and Type	Method	Description
protected String	determineFileName(FileId fileId)	Determines the filename that should be used in the report for the given ID.
void	flush()
String	getDescription()	Get the description of the Renderer.
String	getName()	Get the name of the Renderer.
protected String	getPropertySourceType()
Writer	getWriter()	Get the Writer for the Renderer.
boolean	isShowSuppressedViolations()	Get the indicator for whether to show suppressed violations.
void	setDescription(String description)	Set the description of the Renderer.
void	setFileNameRenderer(FileNameRenderer fileNameRenderer)	Set the FileNameRenderer used to render file paths to the report.
void	setName(String name)	Set the name of the Renderer.
void	setReportFile(String reportFilename)	Sets the filename where the report should be written to.
void	setShowSuppressedViolations(boolean showSuppressedViolations)	Set the indicator for whether to show suppressed violations.
void	setWriter(Writer writer)	Set the Writer for the Renderer.

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, end, newListener, renderFileReport, start, startFileAnalysis

Field Detail

name

protected String name

description

protected String description

showSuppressedViolations

protected boolean showSuppressedViolations

writer

protected PrintWriter writer

Constructor Detail

AbstractRenderer

public AbstractRenderer(String name,
                        String description)

Method Detail

getPropertySourceType

protected String getPropertySourceType()

Specified by:

getPropertySourceType in class AbstractPropertySource

getName

public String getName()

Description copied from interface: Renderer

Get the name of the Renderer.

Specified by:

getName in interface PropertySource

Specified by:

getName in interface Renderer

Returns:

The name of the Renderer.

setName

public void setName(String name)

Description copied from interface: Renderer

Set the name of the Renderer.

Specified by:

setName in interface Renderer

Parameters:

name - The name of the Renderer.

getDescription

public String getDescription()

Description copied from interface: Renderer

Get the description of the Renderer.

Specified by:

getDescription in interface Renderer

Returns:

The description of the Renderer.

setDescription

public void setDescription(String description)

Description copied from interface: Renderer

Set the description of the Renderer.

Specified by:

setDescription in interface Renderer

Parameters:

description - The description of the Renderer.

isShowSuppressedViolations

public boolean isShowSuppressedViolations()

Description copied from interface: Renderer

Get the indicator for whether to show suppressed violations.

Specified by:

isShowSuppressedViolations in interface Renderer

Returns:

true if suppressed violations should show, false otherwise.

setShowSuppressedViolations

public void setShowSuppressedViolations(boolean showSuppressedViolations)

Description copied from interface: Renderer

Set the indicator for whether to show suppressed violations.

Specified by:

setShowSuppressedViolations in interface Renderer

Parameters:

showSuppressedViolations - Whether to show suppressed violations.

setFileNameRenderer

public void setFileNameRenderer(FileNameRenderer fileNameRenderer)

Description copied from interface: Renderer

Set the FileNameRenderer used to render file paths to the report. Note that this renderer does not have to use the parameter to output paths. Some report formats require a specific format for paths (eg a URI), and are allowed to circumvent the provided strategy.

Specified by:

setFileNameRenderer in interface Renderer

Parameters:

fileNameRenderer - a non-null file name renderer

determineFileName

protected final String determineFileName(FileId fileId)

Determines the filename that should be used in the report for the given ID. This uses the FileNameRenderer of this renderer. In the PMD CLI, the file name renderer respects the AbstractConfiguration.getRelativizeRoots() relativize roots to output relative paths.

A renderer does not have to use this method to output paths. Some report formats require a specific format for paths, eg URIs. They can implement this ad-hoc.

setWriter

public void setWriter(Writer writer)

Description copied from interface: Renderer

Set the Writer for the Renderer.

Specified by:

setWriter in interface Renderer

Parameters:

writer - The Writer.

getWriter

public Writer getWriter()

Description copied from interface: Renderer

Get the Writer for the Renderer.

Specified by:

getWriter in interface Renderer

Returns:

The Writer.

flush

public void flush()

Specified by:

flush in interface Renderer

setReportFile

@Experimental
public void setReportFile(String reportFilename)

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

Parameters:

reportFilename - the filename (optional).