net.sourceforge.pmd.renderers

Interface CodeClimateRule

All Superinterfaces:

PropertySource, Rule

public interface CodeClimateRule
extends Rule

This interface tags a Rule specifying properties required for the Code Climate output format. Each rule implementing this interface must define the two code climate properties "categories" and "remediation multiplier".

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CodeClimateRule.CodeClimateCategory Represent a CodeClimate category.

Field Summary

Fields

Modifier and Type	Field and Description
static BooleanProperty	CODECLIMATE_BLOCK_HIGHLIGHTING Defines if the whole related block or just the first line of the issue should be highlighted at the Code Climate Platform.
static EnumeratedMultiProperty<java.lang.String>	CODECLIMATE_CATEGORIES Defines the code climate categories for which this rule will find violations.
static IntegerProperty	CODECLIMATE_REMEDIATION_MULTIPLIER Defines the remediation points for this rule.

Fields inherited from interface net.sourceforge.pmd.Rule

VIOLATION_SUPPRESS_REGEX_DESCRIPTOR, VIOLATION_SUPPRESS_XPATH_DESCRIPTOR

Method Summary

Methods inherited from interface net.sourceforge.pmd.Rule

addExample, addRuleChainVisit, addRuleChainVisit, apply, deepCopy, end, getDescription, getExamples, getExternalInfoUrl, getLanguage, getMaximumLanguageVersion, getMessage, getMinimumLanguageVersion, getName, getParserOptions, getPriority, getRuleChainVisits, getRuleClass, getRuleSetName, getSince, isDeprecated, isDfa, isMultifile, isRuleChain, isTypeResolution, setDeprecated, setDescription, setDfa, setExternalInfoUrl, setLanguage, setMaximumLanguageVersion, setMessage, setMinimumLanguageVersion, setMultifile, setName, setPriority, setRuleClass, setRuleSetName, setSince, setTypeResolution, setUsesDFA, setUsesMultifile, setUsesTypeResolution, start, usesDFA, usesMultifile, usesRuleChain, usesTypeResolution

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

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

Field Detail

CODECLIMATE_CATEGORIES

static final EnumeratedMultiProperty<java.lang.String> CODECLIMATE_CATEGORIES

Defines the code climate categories for which this rule will find violations. Possible categories are: Bug Risk, Clarity, Compatibility, Complexity, Duplication, Performance, Security, Style.

See Also:

Code Climate Spec

CODECLIMATE_REMEDIATION_MULTIPLIER

static final IntegerProperty CODECLIMATE_REMEDIATION_MULTIPLIER

Defines the remediation points for this rule. The remediation points are not set directly but are expressed as a multiplier. The CodeClimateRenderer takes this and multiplies it with CodeClimateRenderer.REMEDIATION_POINTS_DEFAULT, which is the baseline points for a trivial fix (value is 50000).

See Also:

CodeClimateRenderer.REMEDIATION_POINTS_DEFAULT

CODECLIMATE_BLOCK_HIGHLIGHTING

static final BooleanProperty CODECLIMATE_BLOCK_HIGHLIGHTING

Defines if the whole related block or just the first line of the issue should be highlighted at the Code Climate Platform. By default the block highlighting is disabled for reasons of clarity.