net.sourceforge.pmd.renderers

Class CodeClimateRenderer

java.lang.Object

net.sourceforge.pmd.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 and Description
static String	BODY_PLACEHOLDER
static String[]	CODECLIMATE_DEFAULT_CATEGORIES
static String	NAME
protected static String	NULL_CHARACTER
static int	REMEDIATION_POINTS_DEFAULT

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

errors, suppressed

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

description, name, propertyDefinitions, showSuppressedViolations, writer

Fields inherited from class net.sourceforge.pmd.AbstractPropertySource

propertyDescriptors, propertyValuesByDescriptor

Constructor Summary

Constructors

Constructor and Description
CodeClimateRenderer()

Method Summary

Methods

Modifier and Type	Method and 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

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

Methods inherited from class net.sourceforge.pmd.AbstractPropertySource

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

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

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

Field Detail

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

Constructor Detail

CodeClimateRenderer

public CodeClimateRenderer()

Method Detail

renderFileViolations

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

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