open class PmdExtension : CodeQualityExtension
Configuration options for the PMD plugin.
See Also
PmdPlugin
PmdExtension(project: Project) |
open fun getRulePriority(): Int
The rule priority threshold; violations for rules with a lower priority will not be reported. Default value is 5, which means that all violations will be reported. This is equivalent to PMD's Ant task minimumPriority property. See the official documentation for the list of priorities. Example: rulePriority = 3 |
|
open fun getRuleSetConfig(): TextResource
The custom rule set to be used (if any). Replaces |
|
open fun getRuleSetFiles(): FileCollection
The custom rule set files to be used. See the official documentation for how to author a rule set file. Example: ruleSetFiles = files("config/pmd/myRuleSet.xml") |
|
open fun getRuleSets(): MutableList<String>
The built-in rule sets to be used. See the official list of built-in rule sets. Example: ruleSets = ["basic", "braces"] |
|
open fun getTargetJdk(): TargetJdk
The target jdk to use with pmd, 1.3, 1.4, 1.5, 1.6, 1.7 or jsp |
|
open fun isConsoleOutput(): Boolean
Whether or not to write PMD results to |
|
open fun ruleSetFiles(vararg ruleSetFiles: Any): Unit
Convenience method for adding rule set files. Example: ruleSetFiles "config/pmd/myRuleSet.xml" |
|
open fun ruleSets(vararg ruleSets: String): Unit
Convenience method for adding rule sets. Example: ruleSets "basic", "braces" |
|
open fun setConsoleOutput(consoleOutput: Boolean): Unit
Whether or not to write PMD results to |
|
open fun setRulePriority(intValue: Int): Unit
Sets the rule priority threshold. |
|
open fun setRuleSetConfig(ruleSetConfig: TextResource): Unit
The custom rule set to be used (if any). Replaces |
|
open fun setRuleSetFiles(ruleSetFiles: FileCollection): Unit
The custom rule set files to be used. See the official documentation for how to author a rule set file. Example: ruleSetFiles = files("config/pmd/myRuleSet.xml") |
|
open fun setRuleSets(ruleSets: MutableList<String>): Unit
The built-in rule sets to be used. See the official list of built-in rule sets. Example: ruleSets = ["basic", "braces"] |
|
open fun setTargetJdk(targetJdk: TargetJdk): Unitopen fun setTargetJdk(value: Any): Unit
Sets the target jdk used with pmd. |
open fun getReportsDir(): File
The directory where reports will be generated. |
|
open fun getSourceSets(): MutableCollection<SourceSet>
The source sets to be analyzed as part of the check and build tasks. |
|
open fun getToolVersion(): String
The version of the code quality tool to be used. |
|
open fun isIgnoreFailures(): Boolean
Whether to allow the build to continue if there are warnings. Example: ignoreFailures = true |
|
open fun setIgnoreFailures(ignoreFailures: Boolean): Unit
Whether to allow the build to continue if there are warnings. Example: ignoreFailures = true |
|
open fun setReportsDir(reportsDir: File): Unit
The directory where reports will be generated. |
|
open fun setSourceSets(sourceSets: MutableCollection<SourceSet>): Unit
The source sets to be analyzed as part of the check and build tasks. |
|
open fun setToolVersion(toolVersion: String): Unit
The version of the code quality tool to be used. |
val PmdExtension.ext: ExtraPropertiesExtension
Retrieves the ext extension. |
fun PmdExtension.ext(configure: ExtraPropertiesExtension.() -> Unit): Unit
Configures the ext extension. |