Required Parameters

Optional Parameters

Parameter Details

aggregate :

Whether to build an aggregated report at the root, or build individual reports.

• Type: boolean
• Since: 2.2
• Required: No
• Expression: ${aggregate}
• Default: false

excludeRoots :

The project source directories that should be excluded.

• Type: java.io.File[]
• Since: 2.2
• Required: No

excludes :

A list of files to exclude from checking. Can contain Ant-style wildcards and double wildcards. Note that these exclusion patterns only operate on the path of a source file relative to its source root directory. In other words, files are excluded based on their package and/or class name. If you want to exclude entire source root directories, use the parameter excludeRoots instead.

• Type: java.lang.String[]
• Since: 2.2
• Required: No

format :

Set the output format type, in addition to the HTML report. Must be one of: "none", "csv", "xml", "txt" or the full class name of the PMD renderer to use. See the net.sourceforge.pmd.renderers package javadoc for available renderers. XML is required if the pmd:check goal is being used.

• Type: java.lang.String
• Since: 2.0
• Required: No
• Expression: ${format}
• Default: xml

includeTests :

Run PMD on the tests.

• Type: boolean
• Since: 2.2
• Required: No
• Default: false

includes :

A list of files to include from checking. Can contain Ant-style wildcards and double wildcards. Defaults to **\/*.java.

• Type: java.lang.String[]
• Since: 2.2
• Required: No

linkXRef :

Link the violation line numbers to the source xref. Links will be created automatically if the jxr plugin is being used.

• Type: boolean
• Since: 2.0
• Required: No
• Expression: ${linkXRef}
• Default: true

minimumPriority :

The rule priority threshold; rules with lower priority than this will not be evaluated.

• Type: int
• Since: 2.1
• Required: No
• Expression: ${minimumPriority}
• Default: 5

outputDirectory :

The output directory for the final HTML report. Note that this parameter is only evaluated if the goal is run directly from the command line or during the default lifecycle. If the goal is run indirectly as part of a site generation, the output directory configured in the Maven Site Plugin is used instead.

• Type: java.io.File
• Since: 2.0
• Required: Yes
• Expression: ${project.reporting.outputDirectory}

rulesets :

The PMD rulesets to use. See the Stock Rulesets for a list of some included. Defaults to the basic, imports and unusedcode rulesets.

• Type: java.lang.String[]
• Since: 2.0
• Required: No

skip :

Skip the PMD report generation. Most useful on the command line via "-Dpmd.skip=true".

• Type: boolean
• Since: 2.1
• Required: No
• Expression: ${pmd.skip}
• Default: false

sourceEncoding :

The file encoding to use when reading the Java sources.

• Type: java.lang.String
• Since: 2.0
• Required: No
• Expression: ${encoding}
• Default: ${project.build.sourceEncoding}

targetDirectory :

The output directory for the intermediate XML report.

• Type: java.io.File
• Since: 2.0
• Required: Yes
• Expression: ${project.build.directory}

targetJdk :

The target JDK to analyse based on. Should match the target used in the compiler plugin. Valid values are currently 1.3, 1.4, 1.5 and 1.6.

Note: support for 1.6 was added in version 2.3 of this plugin.

• Type: java.lang.String
• Since: 2.0
• Required: No
• Expression: ${targetJdk}

xrefLocation :

Location of the Xrefs to link to.

• Type: java.io.File
• Since: 2.0
• Required: No
• Default: ${project.reporting.outputDirectory}/xref

xrefTestLocation :

Location of the Test Xrefs to link to.

• Type: java.io.File
• Since: 2.0
• Required: No
• Default: ${project.reporting.outputDirectory}/xref-test