Class PmdExtension

    • Constructor Detail

      • PmdExtension

        public PmdExtension​(Project project)
    • Method Detail

      • getRuleSets

        public List<String> getRuleSets()
        The built-in rule sets to be used. See the official list of built-in rule sets. Example: ruleSets = ["basic", "braces"]
      • setRuleSets

        public void setRuleSets​(List<String> ruleSets)
        The built-in rule sets to be used. See the official list of built-in rule sets. Example: ruleSets = ["basic", "braces"]
      • ruleSets

        public void ruleSets​(String... ruleSets)
        Convenience method for adding rule sets. Example: ruleSets "basic", "braces"
        Parameters:
        ruleSets - the rule sets to be added
      • getTargetJdk

        public TargetJdk getTargetJdk()
        The target jdk to use with pmd, 1.3, 1.4, 1.5, 1.6, 1.7 or jsp
      • setTargetJdk

        public void setTargetJdk​(TargetJdk targetJdk)
        Sets the target jdk used with pmd.
        Parameters:
        targetJdk - The target jdk
        Since:
        4.0
      • setTargetJdk

        public void setTargetJdk​(Object value)
        Sets the target jdk used with pmd.
        Parameters:
        value - The value for the target jdk as defined by TargetJdk.toVersion(Object)
      • getRulePriority

        @Incubating
        public int getRulePriority()
        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
      • setRulePriority

        @Incubating
        public void setRulePriority​(int intValue)
        Sets the rule priority threshold.
      • getRuleSetConfig

        @Incubating
        public TextResource getRuleSetConfig()
        The custom rule set to be used (if any). Replaces ruleSetFiles, except that it does not currently support multiple rule sets. See the official documentation for how to author a rule set. Example: ruleSetConfig = resources.text.fromFile("config/pmd/myRuleSet.xml")
        Since:
        2.2
      • setRuleSetConfig

        @Incubating
        public void setRuleSetConfig​(TextResource ruleSetConfig)
        The custom rule set to be used (if any). Replaces ruleSetFiles, except that it does not currently support multiple rule sets. See the official documentation for how to author a rule set. Example: ruleSetConfig = resources.text.fromFile("config/pmd/myRuleSet.xml")
        Since:
        2.2
      • getRuleSetFiles

        public FileCollection getRuleSetFiles()
        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")
      • setRuleSetFiles

        public void setRuleSetFiles​(FileCollection ruleSetFiles)
        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")
      • ruleSetFiles

        public void ruleSetFiles​(Object... ruleSetFiles)
        Convenience method for adding rule set files. Example: ruleSetFiles "config/pmd/myRuleSet.xml"
        Parameters:
        ruleSetFiles - the rule set files to be added
      • isConsoleOutput

        @Incubating
        public boolean isConsoleOutput()
        Whether or not to write PMD results to System.out.
      • setConsoleOutput

        @Incubating
        public void setConsoleOutput​(boolean consoleOutput)
        Whether or not to write PMD results to System.out.