Package org.gradle.api.plugins.quality
Class PmdExtension
java.lang.Object
org.gradle.api.plugins.quality.CodeQualityExtension
org.gradle.api.plugins.quality.PmdExtension
Configuration options for the PMD plugin.
- See Also:
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionControls whether to use incremental analysis or not.The maximum number of failures to allow before stopping the build.The custom rule set to be used (if any).The custom rule set files to be used.The built-in rule sets to be used.The rule priority threshold; violations for rules with a lower priority will not be reported.The target jdk to use with pmd, 1.3, 1.4, 1.5, 1.6, 1.7 or jspThe number of threads used by PMD.booleanWhether or not to write PMD results toSystem.out.voidruleSetFiles(Object... ruleSetFiles) Convenience method for adding rule set files.voidConvenience method for adding rule sets.voidsetConsoleOutput(boolean consoleOutput) Whether or not to write PMD results toSystem.out.voidsetRuleSetConfig(TextResource ruleSetConfig) The custom rule set to be used (if any).voidsetRuleSetFiles(FileCollection ruleSetFiles) The custom rule set files to be used.voidsetRuleSets(List<String> ruleSets) The built-in rule sets to be used.voidsetTargetJdk(Object value) Sets the target jdk used with pmd.voidsetTargetJdk(TargetJdk targetJdk) Sets the target jdk used with pmd.Methods inherited from class org.gradle.api.plugins.quality.CodeQualityExtensiongetReportsDir, getSourceSets, getToolVersion, isIgnoreFailures, setIgnoreFailures, setReportsDir, setSourceSets, setToolVersion
- 
Constructor Details- 
PmdExtension
 
- 
- 
Method Details- 
getRuleSetsThe built-in rule sets to be used. See the official list of built-in rule sets. If not configured explicitly, the returned conventional value is "category/java/errorprone.xml", unlessgetRuleSetConfig()returns. a non-null value or the return value ofgetRuleSetFiles()is non-empty, in which case the conventional value is an empty listruleSets = ["category/java/errorprone.xml", "category/java/bestpractices.xml"]
- 
setRuleSetsThe built-in rule sets to be used. See the official list of built-in rule sets.ruleSets = ["category/java/errorprone.xml", "category/java/bestpractices.xml"]
- 
ruleSetsConvenience method for adding rule sets.ruleSets "category/java/errorprone.xml", "category/java/bestpractices.xml"- Parameters:
- ruleSets- the rule sets to be added
 
- 
getTargetJdkThe target jdk to use with pmd, 1.3, 1.4, 1.5, 1.6, 1.7 or jsp
- 
setTargetJdkSets the target jdk used with pmd.- Parameters:
- targetJdk- The target jdk
- Since:
- 4.0
 
- 
getMaxFailuresThe maximum number of failures to allow before stopping the build. IfignoreFailures is set, this is ignored and no limit is enforced.- Since:
- 6.4
 
- 
setTargetJdkSets the target jdk used with pmd.- Parameters:
- value- The value for the target jdk as defined by- TargetJdk.toVersion(Object)
 
- 
getRulesMinimumPriorityThe 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.rulesMinimumPriority = 3- Since:
- 6.8
 
- 
getRuleSetConfigThe custom rule set to be used (if any). ReplacesruleSetFiles, except that it does not currently support multiple rule sets. See the official documentation for how to author a rule set.ruleSetConfig = resources.text.fromFile("config/pmd/myRuleSet.xml")- Since:
- 2.2
 
- 
setRuleSetConfigThe custom rule set to be used (if any). ReplacesruleSetFiles, except that it does not currently support multiple rule sets. See the official documentation for how to author a rule set.ruleSetConfig = resources.text.fromFile("config/pmd/myRuleSet.xml")- Since:
- 2.2
 
- 
getRuleSetFilesThe custom rule set files to be used. See the official documentation for how to author a rule set file.ruleSetFiles = files("config/pmd/myRuleSet.xml")
- 
setRuleSetFilesThe custom rule set files to be used. See the official documentation for how to author a rule set file. This adds to the default rule sets defined bygetRuleSets().ruleSetFiles = files("config/pmd/myRuleSets.xml")
- 
ruleSetFilesConvenience method for adding rule set files.ruleSetFiles "config/pmd/myRuleSet.xml"- Parameters:
- ruleSetFiles- the rule set files to be added
 
- 
isConsoleOutputpublic boolean isConsoleOutput()Whether or not to write PMD results toSystem.out.
- 
setConsoleOutputpublic void setConsoleOutput(boolean consoleOutput) Whether or not to write PMD results toSystem.out.
- 
getIncrementalAnalysisControls whether to use incremental analysis or not. This is only supported for PMD 6.0.0 or better. See for more details.- Since:
- 5.6
 
- 
getThreadsThe number of threads used by PMD.- Since:
- 7.5
 
 
-