Package net.sourceforge.pmd.renderers

Class CodeClimateRenderer

java.lang.Object

net.sourceforge.pmd.properties.AbstractPropertySource

net.sourceforge.pmd.renderers.AbstractRenderer

net.sourceforge.pmd.renderers.AbstractIncrementingRenderer

net.sourceforge.pmd.renderers.CodeClimateRenderer

All Implemented Interfaces:

PropertySource, Renderer

public class CodeClimateRenderer
extends AbstractIncrementingRenderer

Renderer for Code Climate JSON format

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BODY_PLACEHOLDER
static final String[]	CODECLIMATE_DEFAULT_CATEGORIES
protected static final List<String>	INTERNAL_DEV_PROPERTIES
static final String	NAME
protected static final String	NULL_CHARACTER
static final int	REMEDIATION_POINTS_DEFAULT

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
CodeClimateRenderer()

Method Summary

Modifier and Type	Method	Description
String	defaultFileExtension()	Return the default filename extension to use.
void	renderFileViolations(Iterator<RuleViolation> violations)	Render a series of RuleViolations.

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

end, renderFileReport, start, startFileAnalysis

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

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

BODY_PLACEHOLDER

public static final String BODY_PLACEHOLDER

See Also:

• Constant Field Values

REMEDIATION_POINTS_DEFAULT

public static final int REMEDIATION_POINTS_DEFAULT

See Also:

• Constant Field Values

CODECLIMATE_DEFAULT_CATEGORIES

public static final String[] CODECLIMATE_DEFAULT_CATEGORIES

NULL_CHARACTER

protected static final String NULL_CHARACTER

See Also:

• Constant Field Values

INTERNAL_DEV_PROPERTIES

protected static final List<String> INTERNAL_DEV_PROPERTIES

Constructor Details

CodeClimateRenderer

public CodeClimateRenderer()

Method Details

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

defaultFileExtension

public String defaultFileExtension()

Description copied from interface: Renderer

Return the default filename extension to use.

Returns:

String