Package net.sourceforge.pmd.renderers

Class CSVRenderer

java.lang.Object

net.sourceforge.pmd.properties.AbstractPropertySource

net.sourceforge.pmd.renderers.AbstractRenderer

net.sourceforge.pmd.renderers.AbstractIncrementingRenderer

net.sourceforge.pmd.renderers.CSVRenderer

All Implemented Interfaces:

PropertySource, Renderer

public class CSVRenderer
extends AbstractIncrementingRenderer

Renderer the results to a comma-delimited text format. All available columns are present by default. IDEs can enable/disable columns individually (cmd-line control to follow eventually)

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAME

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

configErrors, errors, suppressed

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

propertyDescriptors, propertyValuesByDescriptor

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

description, name, showSuppressedViolations, writer

Constructor Summary

Constructors

Constructor	Description
CSVRenderer()
CSVRenderer(ColumnDescriptor<RuleViolation>[] columns, java.lang.String theSeparator, java.lang.String theCR)

Method Summary

Modifier and Type	Method	Description
java.lang.String	defaultFileExtension()	Return the default filename extension to use.
java.lang.String	dysfunctionReason()	We can't show any violations if we don't have any visible columns.
void	renderFileViolations(java.util.Iterator<RuleViolation> violations)	Render a series of RuleViolations.
void	start()	This method is called before any source files are processed.

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

end, renderFileReport, startFileAnalysis

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

copyPropertyDescriptors, copyPropertyValues, definePropertyDescriptor, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, setProperty, setProperty, useDefaultValueFor, usesDefaultValues

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

flush, getDescription, getName, getWriter, isShowSuppressedViolations, setDescription, setName, setShowSuppressedViolations, setWriter

Methods inherited from class java.lang.Object

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

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

definePropertyDescriptor, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, setProperty, setProperty, useDefaultValueFor, usesDefaultValues

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

CSVRenderer

public CSVRenderer(ColumnDescriptor<RuleViolation>[] columns,
                   java.lang.String theSeparator,
                   java.lang.String theCR)

CSVRenderer

public CSVRenderer()

Method Detail

start

public void start()
           throws java.io.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:

java.io.IOException

defaultFileExtension

public java.lang.String defaultFileExtension()

Description copied from interface: Renderer

Return the default filename extension to use.

Returns:

String

renderFileViolations

public void renderFileViolations(java.util.Iterator<RuleViolation> violations)
                          throws java.io.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:

java.io.IOException

dysfunctionReason

public java.lang.String dysfunctionReason()

We can't show any violations if we don't have any visible columns.

Specified by:

dysfunctionReason in interface PropertySource

Overrides:

dysfunctionReason in class AbstractPropertySource

Returns:

String

See Also:

PropertySource.dysfunctionReason()