# PmdExtension

abstract class PmdExtension : CodeQualityExtension(source)

Configuration options for the PMD plugin.

#### See also

PmdPlugin

## Constructors

PmdExtension
Link copied to clipboard
constructor(project: Project)

## Properties

incrementalAnalysis
Link copied to clipboard
val incrementalAnalysis: Property<Boolean>
maxFailures
Link copied to clipboard
val maxFailures: Property<Integer>
reportsDir
Link copied to clipboard
open var reportsDir: File
ruleSetConfig
Link copied to clipboard
@get:Nullable
open var ruleSetConfig: TextResource
rulesMinimumPriority
Link copied to clipboard
val rulesMinimumPriority: Property<Integer>
sourceSets
Link copied to clipboard
open var sourceSets: Collection<SourceSet>
targetJdk
Link copied to clipboard
open var targetJdk: TargetJdk
threads
Link copied to clipboard
val threads: Property<Integer>
toolVersion
Link copied to clipboard
open var toolVersion: String

## Functions

getRuleSetFiles
Link copied to clipboard
open fun getRuleSetFiles(): FileCollection
The custom rule set files to be used.
getRuleSets
Link copied to clipboard
open fun getRuleSets(): List<String>
The built-in rule sets to be used.
isConsoleOutput
Link copied to clipboard
open fun isConsoleOutput(): Boolean
Whether or not to write PMD results to `System.out`.
isIgnoreFailures
Link copied to clipboard
open fun isIgnoreFailures(): Boolean
ruleSetFiles
Link copied to clipboard
open fun ruleSetFiles(ruleSetFiles: Array<Any>)
Convenience method for adding rule set files.
ruleSets
Link copied to clipboard
open fun ruleSets(ruleSets: Array<String>)
Convenience method for adding rule sets.
setConsoleOutput
Link copied to clipboard
open fun setConsoleOutput(consoleOutput: Boolean)
Whether or not to write PMD results to `System.out`.
setIgnoreFailures
Link copied to clipboard
open fun setIgnoreFailures(ignoreFailures: Boolean)
setRuleSetFiles
Link copied to clipboard
open fun setRuleSetFiles(ruleSetFiles: FileCollection)
The custom rule set files to be used.
setRuleSets
Link copied to clipboard
open fun setRuleSets(ruleSets: List<String>)
The built-in rule sets to be used.
setTargetJdk
Link copied to clipboard
open fun setTargetJdk(value: Any)
Sets the target jdk used with pmd.