Package org.gradle.api.plugins.quality
Class Pmd
- java.lang.Object
-
- org.gradle.api.internal.AbstractTask
-
- org.gradle.api.DefaultTask
-
- org.gradle.api.internal.ConventionTask
-
- org.gradle.api.tasks.SourceTask
-
- org.gradle.api.plugins.quality.Pmd
-
- All Implemented Interfaces:
Comparable<Task>,org.gradle.api.internal.DynamicObjectAware,org.gradle.api.internal.IConventionAware,org.gradle.api.internal.TaskInternal,ExtensionAware,Reporting<PmdReports>,Task,PatternFilterable,VerificationTask,org.gradle.util.Configurable<Task>
@CacheableTask public class Pmd extends SourceTask implements VerificationTask, Reporting<PmdReports>
Runs a set of static code analysis rules on Java source code files and generates a report of problems found.- See Also:
PmdPlugin,PmdExtension
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.gradle.api.Task
Task.Namer
-
-
Field Summary
-
Fields inherited from interface org.gradle.api.Task
TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
-
-
Constructor Summary
Constructors Constructor Description Pmd()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description org.gradle.api.internal.project.IsolatedAntBuildergetAntBuilder()FileCollectiongetClasspath()Compile class path for the classes to be analyzed.booleangetIgnoreFailures()Whether or not to allow the build to continue if there are warnings.protected ObjectFactorygetObjectFactory()FileCollectiongetPmdClasspath()The class path containing the PMD library to be used.PmdReportsgetReports()The reports to be generated by this task.intgetRulePriority()Specifies the rule priority threshold.TextResourcegetRuleSetConfig()The custom rule set to be used (if any).FileCollectiongetRuleSetFiles()The custom rule set files to be used.List<String>getRuleSets()The built-in rule sets to be used.FileTreegetSource()Returns the source for this task, after the include and exclude patterns have been applied.TargetJdkgetTargetJdk()The target JDK to use with PMD.booleanisConsoleOutput()Whether or not to write PMD results toSystem.out.PmdReportsreports(Closure closure)Configures the reports to be generated by this task.PmdReportsreports(Action<? super PmdReports> configureAction)Configures the reports to be generated by this task.voidrun()voidsetClasspath(FileCollection classpath)Compile class path for the classes to be analyzed.voidsetConsoleOutput(boolean consoleOutput)Whether or not to write PMD results toSystem.out.voidsetIgnoreFailures(boolean ignoreFailures)Whether or not to allow the build to continue if there are warnings.voidsetPmdClasspath(FileCollection pmdClasspath)The class path containing the PMD library to be used.voidsetRulePriority(int intValue)Sets the rule priority threshold.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(TargetJdk targetJdk)The target JDK to use with PMD.booleanstdOutIsAttachedToTerminal()static voidvalidate(int value)Validates the value is a valid PMD RulePriority (1-5)-
Methods inherited from class org.gradle.api.tasks.SourceTask
exclude, exclude, exclude, exclude, getExcludes, getIncludes, getPatternSetFactory, include, include, include, include, setExcludes, setIncludes, setSource, setSource, source
-
Methods inherited from class org.gradle.api.internal.ConventionTask
conventionMapping, conventionMapping, getConventionMapping
-
Methods inherited from class org.gradle.api.DefaultTask
newInputDirectory, newInputFile, newOutputDirectory, newOutputFile
-
Methods inherited from class org.gradle.api.internal.AbstractTask
appendParallelSafeAction, compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getTimeout, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString
-
-
-
-
Method Detail
-
getObjectFactory
@Inject protected ObjectFactory getObjectFactory()
-
getAntBuilder
@Inject public org.gradle.api.internal.project.IsolatedAntBuilder getAntBuilder()
-
run
public void run()
-
stdOutIsAttachedToTerminal
public boolean stdOutIsAttachedToTerminal()
-
reports
public PmdReports reports(@DelegatesTo(value=PmdReports.class,strategy=1) Closure closure)
Configures the reports to be generated by this task.- Specified by:
reportsin interfaceReporting<PmdReports>- Parameters:
closure- The configuration- Returns:
- The report container
-
reports
public PmdReports reports(Action<? super PmdReports> configureAction)
Configures the reports to be generated by this task.- Specified by:
reportsin interfaceReporting<PmdReports>- Parameters:
configureAction- The configuration- Returns:
- The report container
- Since:
- 3.0
-
validate
public static void validate(int value)
Validates the value is a valid PMD RulePriority (1-5)- Parameters:
value- rule priority threshold
-
getSource
@PathSensitive(RELATIVE) public FileTree getSource()
Returns the source for this task, after the include and exclude patterns have been applied. Ignores source files which do not exist.The
PathSensitivityfor the sources is configured to bePathSensitivity.ABSOLUTE. If your sources are less strict, please change it accordingly by overriding this method in your subclass.- Overrides:
getSourcein classSourceTask- Returns:
- The source.
-
getPmdClasspath
@Classpath public FileCollection getPmdClasspath()
The class path containing the PMD library to be used.
-
setPmdClasspath
public void setPmdClasspath(FileCollection pmdClasspath)
The class path containing the PMD library to be used.
-
getRuleSets
@Input 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"]
-
setTargetJdk
public void setTargetJdk(TargetJdk targetJdk)
The target JDK to use with PMD.
-
getRuleSetConfig
@Nullable @Optional public TextResource getRuleSetConfig()
The 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. Example: ruleSetConfig = resources.text.fromFile(resources.file("config/pmd/myRuleSets.xml"))- Since:
- 2.2
-
setRuleSetConfig
public void setRuleSetConfig(@Nullable TextResource ruleSetConfig)
The 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. Example: ruleSetConfig = resources.text.fromFile(resources.file("config/pmd/myRuleSets.xml"))- Since:
- 2.2
-
getRuleSetFiles
@InputFiles @PathSensitive(NONE) 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/myRuleSets.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/myRuleSets.xml")
-
getReports
public final PmdReports getReports()
The reports to be generated by this task.- Specified by:
getReportsin interfaceReporting<PmdReports>- Returns:
- The report container
-
getIgnoreFailures
public boolean getIgnoreFailures()
Whether or not to allow the build to continue if there are warnings. Example: ignoreFailures = true- Specified by:
getIgnoreFailuresin interfaceVerificationTask- Returns:
- false, when the build should break on failure, true when the failures should be ignored.
-
setIgnoreFailures
public void setIgnoreFailures(boolean ignoreFailures)
Whether or not to allow the build to continue if there are warnings. Example: ignoreFailures = true- Specified by:
setIgnoreFailuresin interfaceVerificationTask- Parameters:
ignoreFailures- false to break the build on failure, true to ignore the failures. The default is false.
-
getRulePriority
@Input public int getRulePriority()
Specifies the rule priority threshold.- Since:
- 2.8
- See Also:
PmdExtension.rulePriority
-
setRulePriority
public void setRulePriority(int intValue)
Sets the rule priority threshold.- Since:
- 2.8
-
isConsoleOutput
@Input public boolean isConsoleOutput()
Whether or not to write PMD results toSystem.out.- Since:
- 2.1
-
setConsoleOutput
public void setConsoleOutput(boolean consoleOutput)
Whether or not to write PMD results toSystem.out.- Since:
- 2.1
-
getClasspath
@Nullable @Optional @Classpath public FileCollection getClasspath()
Compile class path for the classes to be analyzed. The classes on this class path are used during analysis but aren't analyzed themselves. This is only well supported for PMD 5.2.1 or better.- Since:
- 2.8
-
setClasspath
public void setClasspath(@Nullable FileCollection classpath)
Compile class path for the classes to be analyzed. The classes on this class path are used during analysis but aren't analyzed themselves. This is only well supported for PMD 5.2.1 or better.- Since:
- 2.8
-
-