phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(doc) violationSuppressXPath with matches

Browse Source
This commit is contained in:
Andreas Dangel
2019-06-14 15:05:38 +02:00
parent d9a441c7d6
commit e0afb87641
1 changed files with 10 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/pages/pmd/userdocs/suppressing_warnings.md
View File

@ -192,10 +192,10 @@ then the violation will be suppressed. Note that the query shouldn't be finding
the violation nodes to suppress, but rather, finding a non-empty sequence of nodes the violation nodes to suppress, but rather, finding a non-empty sequence of nodes
when evaluated with the violation node as a context node. when evaluated with the violation node as a context node.
The XPath version used by those queries is XPath 1.0, so it doesn't support e.g. The XPath version used by those queries is XPath 1.0, so it doesn't support various XPath 2.0
regex tests. This will be updated with PMD 7.0.0. features. This will be updated with PMD 7.0.0.
For example, to suppress reporting specifically typed parameters which are unused: For example, to suppress reporting specifically "String" parameters which are unused:
```xml ```xml
<rule ref="rulesets/java/unusedcode.xml/UnusedFormalParameter"> <rule ref="rulesets/java/unusedcode.xml/UnusedFormalParameter">
@ -214,7 +214,13 @@ Another example, to suppress violations occurring in classes whose name contains
<property name="violationSuppressXPath" value="./ancestor::ClassOrInterfaceDeclaration[contains(@Image, 'Bean')]"/> <property name="violationSuppressXPath" value="./ancestor::ClassOrInterfaceDeclaration[contains(@Image, 'Bean')]"/>
``` ```
Note here the used of the `./ancestor::` axis instead of `//`. The latter would match You can also use regex for string comparison. The next example suppresses violations in classes ending with `Bean`:
```xml
<property name="violationSuppressXPath" value="./ancestor::ClassOrInterfaceDeclaration[matches(@Image, '^.*Bean$')]"/>
```
Note here the usage of the `./ancestor::` axis instead of `//`. The latter would match
any ClassOrInterfaceDeclaration in the file, while the former matches only class any ClassOrInterfaceDeclaration in the file, while the former matches only class
declaration nodes that *enclose the violation node*, which is usually what you'd want. declaration nodes that *enclose the violation node*, which is usually what you'd want.