This page describes XPath rule support in more details
Table of Contents
This page describes some points of XPath rule support in more details. See also the tutorial about how to write a first (XPath) rule.
XPath version
PMD uses XPath 3.1 for its XPath rules since PMD 7. Before then, the default version was XPath 1.0, with opt-in support for XPath 2.0.
See the Saxonica documentation for an introduction to new features in XPath 3.1.
The property version of XPathRule is deprecated and
has been removed with PMD 7.
DOM representation of ASTs
XPath rules view the AST as an XML-like DOM, which is what the XPath language is defined on. Concretely, this means:
- Every AST node is viewed as an XML element
- The element has for local name the value of
getXPathNodeNamefor the given node
- The element has for local name the value of
- Some Java getters are exposed as XML attributes on those elements
- This means, that documentation for attributes can be found in our Javadocs. For
example, the attribute
@SimpleNameof the Java nodeEnumDeclarationis backed by the Java gettergetSimpleName.
- This means, that documentation for attributes can be found in our Javadocs. For
example, the attribute
Value conversion
To represent attributes, we must map Java values to XPath Data Model (XDM)
values. In the following table we refer to the type conversion function as conv, a function from Java types
to XDM types.
Java type T |
XSD type conv(T) |
|---|---|
int |
xs:integer |
long |
xs:integer |
double |
xs:decimal |
float |
xs:decimal |
boolean |
xs:boolean |
String |
xs:string |
Character |
xs:string |
Enum<E> |
xs:string (uses Object::toString) |
List<E> |
conv(E)* (a sequence type) |
The same conv function is used to translate rule property values to XDM values.
Warning: Lists are only supported for rule properties, not attributes.
Rule properties
PMD extension functions
PMD provides some language-specific XPath functions to access semantic information from the AST.
The namespace of custom PMD functions must be explicitly mentioned.
All languages
Functions available to all languages are in the namespace pmd.
<table width="100%">
<thead>
<tr>
<th>Function name</th>
<th>Description (click for details)</th>
<th></th>
</tr>
</thead>
<tr data-toggle="collapse" id="pmd-fileName" data-target="#pmd-fileName-expand" class="accordion-toggle">
<td>fileName</td>
<td>Returns the simple name of the current file</td>
<td>
<button type="button" class="btn btn-link"><i
class="fas fa-ellipsis-h"></i></button>
</td>
</tr>
<tr>
<td colspan="4" class="hiddenRow">
<div class="accordion-body collapse" id="pmd-fileName-expand">
<div style="margin-left: 15px" class="xpath-fun-doc">
<!-- Yeah the ID is duplicated but it's ok on my browser and makes -->
<!--links somehow work when details are collapsed -->
<h4 class="fun-details-header" id="pmd-fileName">
<span class="fun-ns">pmd:</span><span
class="fun-name">fileName</span><span
class="fun-ns">() as xs:string</span>
</h4>
<div style="margin-left: 30px">
<dl>
<dd>Returns the current simple file name, without path but including the extension. This can be used to write rules that check file naming conventions.
</dd>
<dt>Since</dt>
<dd>PMD 6.38.0</dd>
<dt>Remarks</dt>
<dd>The requires the context node to be an element</dd>
<dt>Examples</dt>
<dd>
<dl class="code-examples">
<dt><code>//b[pmd:fileName() = 'Foo.xml']</code></dt>
<dd>Matches any <code><b></code> tags in files called <code>Foo.xml</code>.</dd>
</dl>
</dd>
</dl>
</div>
</div>
</div>
</td>
</tr>
<tr data-toggle="collapse" id="pmd-startLine" data-target="#pmd-startLine-expand" class="accordion-toggle">
<td>startLine</td>
<td>Returns the start line of the given node</td>
<td>
<button type="button" class="btn btn-link"><i
class="fas fa-ellipsis-h"></i></button>
</td>
</tr>
<tr>
<td colspan="4" class="hiddenRow">
<div class="accordion-body collapse" id="pmd-startLine-expand">
<div style="margin-left: 15px" class="xpath-fun-doc">
<!-- Yeah the ID is duplicated but it's ok on my browser and makes -->
<!--links somehow work when details are collapsed -->
<h4 class="fun-details-header" id="pmd-startLine">
<span class="fun-ns">pmd:</span><span
class="fun-name">startLine</span><span
class="fun-ns">(xs:element) as xs:int</span>
</h4>
<div style="margin-left: 30px">
<dl>
<dd>Returns the line where the node starts in the source file. Line numbers are 1-based.
</dd>
<dt>Since</dt>
<dd>PMD 6.44.0</dd>
<dt>Remarks</dt>
<dd>The function is not context-dependent, but takes a node as its first parameter.
</dd>
<dt>Parameters</dt>
<dd>
<dl>
<dt>
<span class="param-name">element</span>
<span class="param-type"> as xs:element</span>
</dt>
<dd>Any element node</dd>
</dl>
</dd>
<dt>Examples</dt>
<dd>
<dl class="code-examples">
<dt><code>//b[pmd:startLine(.) > 5]</code></dt>
<dd>Matches any <code><b></code> node which starts after the fifth line.</dd>
</dl>
</dd>
</dl>
</div>
</div>
</div>
</td>
</tr>
<tr data-toggle="collapse" id="pmd-endLine" data-target="#pmd-endLine-expand" class="accordion-toggle">
<td>endLine</td>
<td>Returns the end line of the given node</td>
<td>
<button type="button" class="btn btn-link"><i
class="fas fa-ellipsis-h"></i></button>
</td>
</tr>
<tr>
<td colspan="4" class="hiddenRow">
<div class="accordion-body collapse" id="pmd-endLine-expand">
<div style="margin-left: 15px" class="xpath-fun-doc">
<!-- Yeah the ID is duplicated but it's ok on my browser and makes -->
<!--links somehow work when details are collapsed -->
<h4 class="fun-details-header" id="pmd-endLine">
<span class="fun-ns">pmd:</span><span
class="fun-name">endLine</span><span
class="fun-ns">(xs:element) as xs:int</span>
</h4>
<div style="margin-left: 30px">
<dl>
<dd>Returns the line where the node ends in the source file. Line numbers are 1-based.
</dd>
<dt>Since</dt>
<dd>PMD 6.44.0</dd>
<dt>Remarks</dt>
<dd>The function is not context-dependent, but takes a node as its first parameter.
</dd>
<dt>Parameters</dt>
<dd>
<dl>
<dt>
<span class="param-name">element</span>
<span class="param-type"> as xs:element</span>
</dt>
<dd>Any element node</dd>
</dl>
</dd>
<dt>Examples</dt>
<dd>
<dl class="code-examples">
<dt><code>//b[pmd:endLine(.) == pmd:startLine(.)]</code></dt>
<dd>Matches any <code><b></code> node which doesn't span more than one line.</dd>
</dl>
</dd>
</dl>
</div>
</div>
</div>
</td>
</tr>
<tr data-toggle="collapse" id="pmd-startColumn" data-target="#pmd-startColumn-expand" class="accordion-toggle">
<td>startColumn</td>
<td>Returns the start column of the given node (inclusive)</td>
<td>
<button type="button" class="btn btn-link"><i
class="fas fa-ellipsis-h"></i></button>
</td>
</tr>
<tr>
<td colspan="4" class="hiddenRow">
<div class="accordion-body collapse" id="pmd-startColumn-expand">
<div style="margin-left: 15px" class="xpath-fun-doc">
<!-- Yeah the ID is duplicated but it's ok on my browser and makes -->
<!--links somehow work when details are collapsed -->
<h4 class="fun-details-header" id="pmd-startColumn">
<span class="fun-ns">pmd:</span><span
class="fun-name">startColumn</span><span
class="fun-ns">(xs:element) as xs:int</span>
</h4>
<div style="margin-left: 30px">
<dl>
<dd>Returns the column number where the node starts in the source file. Column numbers are 1-based. The start column is inclusive.
</dd>
<dt>Since</dt>
<dd>PMD 6.44.0</dd>
<dt>Remarks</dt>
<dd>The function is not context-dependent, but takes a node as its first parameter.
</dd>
<dt>Parameters</dt>
<dd>
<dl>
<dt>
<span class="param-name">element</span>
<span class="param-type"> as xs:element</span>
</dt>
<dd>Any element node</dd>
</dl>
</dd>
<dt>Examples</dt>
<dd>
<dl class="code-examples">
<dt><code>//b[pmd:startColumn(.) = 1]</code></dt>
<dd>Matches any <code><b></code> node which starts on the first column of a line</dd>
</dl>
</dd>
</dl>
</div>
</div>
</div>
</td>
</tr>
<tr data-toggle="collapse" id="pmd-endColumn" data-target="#pmd-endColumn-expand" class="accordion-toggle">
<td>endColumn</td>
<td>Returns the end column of the given node (exclusive)</td>
<td>
<button type="button" class="btn btn-link"><i
class="fas fa-ellipsis-h"></i></button>
</td>
</tr>
<tr>
<td colspan="4" class="hiddenRow">
<div class="accordion-body collapse" id="pmd-endColumn-expand">
<div style="margin-left: 15px" class="xpath-fun-doc">
<!-- Yeah the ID is duplicated but it's ok on my browser and makes -->
<!--links somehow work when details are collapsed -->
<h4 class="fun-details-header" id="pmd-endColumn">
<span class="fun-ns">pmd:</span><span
class="fun-name">endColumn</span><span
class="fun-ns">(xs:element) as xs:int</span>
</h4>
<div style="margin-left: 30px">
<dl>
<dd>Returns the column number where the node ends in the source file. Column numbers are 1-based. The end column is exclusive.
</dd>
<dt>Since</dt>
<dd>PMD 6.44.0</dd>
<dt>Remarks</dt>
<dd>The function is not context-dependent, but takes a node as its first parameter.
</dd>
<dt>Parameters</dt>
<dd>
<dl>
<dt>
<span class="param-name">element</span>
<span class="param-type"> as xs:element</span>
</dt>
<dd>Any element node</dd>
</dl>
</dd>
<dt>Examples</dt>
<dd>
<dl class="code-examples">
<dt><code>//b[pmd:startLine(.) = pmd:endLine(.) and pmd:endColumn(.) - pmd:startColumn(.) = 1]</code></dt>
<dd>Matches any <code><b></code> node which spans exactly one character</dd>
</dl>
</dd>
</dl>
</div>
</div>
</div>
</td>
</tr>
</table>
Java
Java functions are in the namespace pmd-java.
<table width="100%">
<thead>
<tr>
<th>Function name</th>
<th>Description (click for details)</th>
<th></th>
</tr>
</thead>
<tr data-toggle="collapse" id="pmd-java-nodeIs" data-target="#pmd-java-nodeIs-expand" class="accordion-toggle">
<td>nodeIs</td>
<td>Tests the runtime type of the node instance</td>
<td>
<button type="button" class="btn btn-link"><i
class="fas fa-ellipsis-h"></i></button>
</td>
</tr>
<tr>
<td colspan="4" class="hiddenRow">
<div class="accordion-body collapse" id="pmd-java-nodeIs-expand">
<div style="margin-left: 15px" class="xpath-fun-doc">
<!-- Yeah the ID is duplicated but it's ok on my browser and makes -->
<!--links somehow work when details are collapsed -->
<h4 class="fun-details-header" id="pmd-java-nodeIs">
<span class="fun-ns">pmd-java:</span><span
class="fun-name">nodeIs</span><span
class="fun-ns">(xs:string) as xs:boolean</span>
</h4>
<div style="margin-left: 30px">
<dl>
<dd>Returns true if the runtime type of the AST node is a subtype of the given class. Contrary to typeIs, this tests the type of the AST node. For example, the AST node for a literal (e.g. <code>5d</code>) has type ASTNumericLiteral, and this function will ignore the static type of the expression (double)</dd>
<dt>Remarks</dt>
<dd></dd>
<dt>Parameters</dt>
<dd>
<dl>
<dt>
<span class="param-name">nodeClassName</span>
<span class="param-type"> as xs:string</span>
</dt>
<dd>Simple name of a class or interface in package <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.0.0-SNAPSHOT/net/sourceforge/pmd/lang/java/ast/package-summary.html#"><code>net.sourceforge.pmd.lang.java.ast</code></a>, without the 'AST' prefix</dd>
</dl>
</dd>
<dt>Examples</dt>
<dd>
<dl class="code-examples">
<dt><code>//*[pmd-java:nodeIs("Expression")]</code></dt>
<dd>Matches all nodes that implement <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.0.0-SNAPSHOT/net/sourceforge/pmd/lang/java/ast/ASTExpression.html#"><code>ASTExpression</code></a></dd>
<dt><code>//*[pmd-java:nodeIs("TypeDeclaration")]</code></dt>
<dd>Matches all nodes that implement <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.0.0-SNAPSHOT/net/sourceforge/pmd/lang/java/ast/ASTTypeDeclaration.html#"><code>ASTTypeDeclaration</code></a></dd>
<dt><code>//*[pmd-java:nodeIs("Foo")]</code></dt>
<dd>Runtime error, there's no class ASTFoo in the package</dd>
</dl>
</dd>
</dl>
</div>
</div>
</div>
</td>
</tr>
<tr data-toggle="collapse" id="pmd-java-typeIs" data-target="#pmd-java-typeIs-expand" class="accordion-toggle">
<td>typeIs</td>
<td>Tests a node's static type</td>
<td>
<button type="button" class="btn btn-link"><i
class="fas fa-ellipsis-h"></i></button>
</td>
</tr>
<tr>
<td colspan="4" class="hiddenRow">
<div class="accordion-body collapse" id="pmd-java-typeIs-expand">
<div style="margin-left: 15px" class="xpath-fun-doc">
<!-- Yeah the ID is duplicated but it's ok on my browser and makes -->
<!--links somehow work when details are collapsed -->
<h4 class="fun-details-header" id="pmd-java-typeIs">
<span class="fun-ns">pmd-java:</span><span
class="fun-name">typeIs</span><span
class="fun-ns">(xs:string) as xs:boolean</span>
</h4>
<div style="margin-left: 30px">
<dl>
<dd>Returns true if the context node's static Java type is a subtype of the given type. This tests for the resolved type of the Java construct, not the type of the AST node. For example, the AST node for a literal (e.g. <code>5d</code>) has type ASTNumericLiteral, however this function will compare the type of the literal (eg here, <code>double</code>) against the argument.</dd>
<dt>Remarks</dt>
<dd>The context node must be a <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.0.0-SNAPSHOT/net/sourceforge/pmd/lang/java/ast/TypeNode.html#"><code>TypeNode</code></a></dd>
<dt>Parameters</dt>
<dd>
<dl>
<dt>
<span class="param-name">javaQualifiedName</span>
<span class="param-type"> as xs:string</span>
</dt>
<dd>The qualified name of a Java class, possibly with pairs of brackets to indicate an array type. Can also be a primitive type name.</dd>
</dl>
</dd>
<dt>Examples</dt>
<dd>
<dl class="code-examples">
<dt><code>//FormalParameter[pmd-java:typeIs("java.lang.String[]")]</code></dt>
<dd>Matches formal parameters of type <code>String[]</code> (including vararg parameters)</dd>
<dt><code>//VariableId[pmd-java:typeIs("java.lang.List")]</code></dt>
<dd>Matches variable declarators of type <code>List</code> or any of its subtypes (including e.g. <code>ArrayList</code>)</dd>
</dl>
</dd>
</dl>
</div>
</div>
</div>
</td>
</tr>
<tr data-toggle="collapse" id="pmd-java-typeIsExactly" data-target="#pmd-java-typeIsExactly-expand" class="accordion-toggle">
<td>typeIsExactly</td>
<td>Tests a node's static type, ignoring subtypes</td>
<td>
<button type="button" class="btn btn-link"><i
class="fas fa-ellipsis-h"></i></button>
</td>
</tr>
<tr>
<td colspan="4" class="hiddenRow">
<div class="accordion-body collapse" id="pmd-java-typeIsExactly-expand">
<div style="margin-left: 15px" class="xpath-fun-doc">
<!-- Yeah the ID is duplicated but it's ok on my browser and makes -->
<!--links somehow work when details are collapsed -->
<h4 class="fun-details-header" id="pmd-java-typeIsExactly">
<span class="fun-ns">pmd-java:</span><span
class="fun-name">typeIsExactly</span><span
class="fun-ns">(xs:string) as xs:boolean</span>
</h4>
<div style="margin-left: 30px">
<dl>
<dd>Returns true if the context node's static type is exactly the given type. In particular, returns false if the context node's type is a subtype of the given type.</dd>
<dt>Remarks</dt>
<dd>The context node must be a <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.0.0-SNAPSHOT/net/sourceforge/pmd/lang/java/ast/TypeNode.html#"><code>TypeNode</code></a></dd>
<dt>Parameters</dt>
<dd>
<dl>
<dt>
<span class="param-name">javaQualifiedName</span>
<span class="param-type"> as xs:string</span>
</dt>
<dd>The qualified name of a Java class, possibly with pairs of brackets to indicate an array type. Can also be a primitive type name.</dd>
</dl>
</dd>
<dt>Examples</dt>
<dd>
<dl class="code-examples">
<dt><code>//VariableId[pmd-java:typeIsExactly("java.lang.List")]</code></dt>
<dd>Matches variable declarators of type <code>List</code> (but not e.g. <code>ArrayList</code>)</dd>
</dl>
</dd>
</dl>
</div>
</div>
</div>
</td>
</tr>
<tr data-toggle="collapse" id="pmd-java-metric" data-target="#pmd-java-metric-expand" class="accordion-toggle">
<td>metric</td>
<td>Computes and returns the value of a metric</td>
<td>
<button type="button" class="btn btn-link"><i
class="fas fa-ellipsis-h"></i></button>
</td>
</tr>
<tr>
<td colspan="4" class="hiddenRow">
<div class="accordion-body collapse" id="pmd-java-metric-expand">
<div style="margin-left: 15px" class="xpath-fun-doc">
<!-- Yeah the ID is duplicated but it's ok on my browser and makes -->
<!--links somehow work when details are collapsed -->
<h4 class="fun-details-header" id="pmd-java-metric">
<span class="fun-ns">pmd-java:</span><span
class="fun-name">metric</span><span
class="fun-ns">(xs:string) as xs:decimal?</span>
</h4>
<div style="margin-left: 30px">
<dl>
<dd>Returns the value of the metric as evaluated on the context node. If the metric cannot be computed on that node, returns an empty sequence (which is falsy).</dd>
<dt>Remarks</dt>
<dd></dd>
<dt>Parameters</dt>
<dd>
<dl>
<dt>
<span class="param-name">metricKey</span>
<span class="param-type"> as xs:string</span>
</dt>
<dd>The name of a metric in <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.0.0-SNAPSHOT/net/sourceforge/pmd/lang/java/metrics/JavaMetrics.html#"><code>JavaMetrics</code></a> (or an alias thereof).</dd>
</dl>
</dd>
<dt>Examples</dt>
<dd>
<dl class="code-examples">
<dt><code>//ClassDeclaration[metric('NCSS') > 200]</code></dt>
<dd></dd>
<dt><code>//MethodDeclaration[metric('CYCLO') > 10 and metric('NCSS') > 20]</code></dt>
<dd></dd>
<dt><code>//TypeParameter[metric('idontexist') > 50]</code></dt>
<dd>Error: no such metric</dd>
</dl>
</dd>
</dl>
</div>
</div>
</div>
</td>
</tr>
<tr data-toggle="collapse" id="pmd-java-hasAnnotation" data-target="#pmd-java-hasAnnotation-expand" class="accordion-toggle">
<td>hasAnnotation</td>
<td>Tests whether an annotation is present on the node</td>
<td>
<button type="button" class="btn btn-link"><i
class="fas fa-ellipsis-h"></i></button>
</td>
</tr>
<tr>
<td colspan="4" class="hiddenRow">
<div class="accordion-body collapse" id="pmd-java-hasAnnotation-expand">
<div style="margin-left: 15px" class="xpath-fun-doc">
<!-- Yeah the ID is duplicated but it's ok on my browser and makes -->
<!--links somehow work when details are collapsed -->
<h4 class="fun-details-header" id="pmd-java-hasAnnotation">
<span class="fun-ns">pmd-java:</span><span
class="fun-name">hasAnnotation</span><span
class="fun-ns">(xs:string) as xs:boolean</span>
</h4>
<div style="margin-left: 30px">
<dl>
<dd>Returns true if the node has an annotation with the given qualified name</dd>
<dt>Remarks</dt>
<dd>The context node must be an <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.0.0-SNAPSHOT/net/sourceforge/pmd/lang/java/ast/Annotatable.html#"><code>Annotatable</code></a>, otherwise this returns false</dd>
<dt>Parameters</dt>
<dd>
<dl>
<dt>
<span class="param-name">annotationClassName</span>
<span class="param-type"> as xs:string</span>
</dt>
<dd>Canonical name of an annotation type</dd>
</dl>
</dd>
<dt>Examples</dt>
<dd>
<dl class="code-examples">
<dt><code>//MethodDeclaration[pmd-java:hasAnnotation("java.lang.Override")]</code></dt>
<dd>Matches all method declarations that are annotated with @Override</dd>
</dl>
</dd>
</dl>
</div>
</div>
</div>
</td>
</tr>
<tr data-toggle="collapse" id="pmd-java-modifiers" data-target="#pmd-java-modifiers-expand" class="accordion-toggle">
<td>modifiers</td>
<td>Produce the effective modifiers of a node</td>
<td>
<button type="button" class="btn btn-link"><i
class="fas fa-ellipsis-h"></i></button>
</td>
</tr>
<tr>
<td colspan="4" class="hiddenRow">
<div class="accordion-body collapse" id="pmd-java-modifiers-expand">
<div style="margin-left: 15px" class="xpath-fun-doc">
<!-- Yeah the ID is duplicated but it's ok on my browser and makes -->
<!--links somehow work when details are collapsed -->
<h4 class="fun-details-header" id="pmd-java-modifiers">
<span class="fun-ns">pmd-java:</span><span
class="fun-name">modifiers</span><span
class="fun-ns">() as xs:string*</span>
</h4>
<div style="margin-left: 30px">
<dl>
<dd>Returns a sequence of the effective modifiers of a node as strings. This is documented on <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.0.0-SNAPSHOT/net/sourceforge/pmd/lang/java/ast/ASTModifierList.html#getEffectiveModifiers()"><code>getEffectiveModifiers</code></a>.</dd>
<dt>Remarks</dt>
<dd>The context node must be an <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.0.0-SNAPSHOT/net/sourceforge/pmd/lang/java/ast/ModifierOwner.html#"><code>ModifierOwner</code></a>, otherwise this returns an empty sequence</dd>
<dt>Examples</dt>
<dd>
<dl class="code-examples">
<dt><code>//MethodDeclaration[pmd-java:modifiers() = "native"]</code></dt>
<dd>Matches native method declarations</dd>
<dt><code>//MethodDeclaration[pmd-java:modifiers() = ("native", "static")]</code></dt>
<dd>Matches method declarations that have a 'native' OR a 'static' modifier. This may be counter-intuitive.</dd>
<dt><code>//MethodDeclaration[pmd-java:modifiers() = "public"]</code></dt>
<dd>Matches method declarations that have a 'public' modifier, explicit or implicit. For example, this would match methods in interfaces, which implicitly have the modifier. Use the <code>explicitModifiers</code> function if you don't want the implicit part. Also note that <code>@Visibility = 'public'</code> is a better use of the API, in this particular instance.</dd>
</dl>
</dd>
</dl>
</div>
</div>
</div>
</td>
</tr>
<tr data-toggle="collapse" id="pmd-java-explicitModifiers" data-target="#pmd-java-explicitModifiers-expand" class="accordion-toggle">
<td>explicitModifiers</td>
<td>Produce the explicit modifiers of a node</td>
<td>
<button type="button" class="btn btn-link"><i
class="fas fa-ellipsis-h"></i></button>
</td>
</tr>
<tr>
<td colspan="4" class="hiddenRow">
<div class="accordion-body collapse" id="pmd-java-explicitModifiers-expand">
<div style="margin-left: 15px" class="xpath-fun-doc">
<!-- Yeah the ID is duplicated but it's ok on my browser and makes -->
<!--links somehow work when details are collapsed -->
<h4 class="fun-details-header" id="pmd-java-explicitModifiers">
<span class="fun-ns">pmd-java:</span><span
class="fun-name">explicitModifiers</span><span
class="fun-ns">() as xs:string*</span>
</h4>
<div style="margin-left: 30px">
<dl>
<dd>Returns a sequence of the explicit modifiers of a node as strings. This is documented on <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.0.0-SNAPSHOT/net/sourceforge/pmd/lang/java/ast/ASTModifierList.html#getExplicitModifiers()"><code>getExplicitModifiers</code></a>.</dd>
<dt>Remarks</dt>
<dd>The context node must be an <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.0.0-SNAPSHOT/net/sourceforge/pmd/lang/java/ast/ModifierOwner.html#"><code>ModifierOwner</code></a>, otherwise this returns an empty sequence</dd>
<dt>Examples</dt>
<dd>
<dl class="code-examples">
<dt><code>//MethodDeclaration[pmd-java:explicitModifiers() = "public"]</code></dt>
<dd>Matches method declarations that have an explicit 'public' modifier.</dd>
</dl>
</dd>
</dl>
</div>
</div>
</div>
</td>
</tr>
<tr data-toggle="collapse" id="pmd-java-matchesSig" data-target="#pmd-java-matchesSig-expand" class="accordion-toggle">
<td>matchesSig</td>
<td>Matches the signature called by a method or constructor call</td>
<td>
<button type="button" class="btn btn-link"><i
class="fas fa-ellipsis-h"></i></button>
</td>
</tr>
<tr>
<td colspan="4" class="hiddenRow">
<div class="accordion-body collapse" id="pmd-java-matchesSig-expand">
<div style="margin-left: 15px" class="xpath-fun-doc">
<!-- Yeah the ID is duplicated but it's ok on my browser and makes -->
<!--links somehow work when details are collapsed -->
<h4 class="fun-details-header" id="pmd-java-matchesSig">
<span class="fun-ns">pmd-java:</span><span
class="fun-name">matchesSig</span><span
class="fun-ns">(xs:string) as xs:boolean</span>
</h4>
<div style="margin-left: 30px">
<dl>
<dd>Uses an <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.0.0-SNAPSHOT/net/sourceforge/pmd/lang/java/types/TypeTestUtil.InvocationMatcher.html#"><code>TypeTestUtil.InvocationMatcher</code></a> to test the method signature called by the context node. The format of the parameter is described on that class.</dd>
<dt>Remarks</dt>
<dd>The context node must be an <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.0.0-SNAPSHOT/net/sourceforge/pmd/lang/java/ast/InvocationNode.html#"><code>InvocationNode</code></a>, otherwise this returns false</dd>
<dt>Parameters</dt>
<dd>
<dl>
<dt>
<span class="param-name">sig</span>
<span class="param-type"> as xs:string</span>
</dt>
<dd>A signature, in the format described on <a href="https://docs.pmd-code.org/apidocs/pmd-java/7.0.0-SNAPSHOT/net/sourceforge/pmd/lang/java/types/TypeTestUtil.InvocationMatcher.html#"><code>TypeTestUtil.InvocationMatcher</code></a></dd>
</dl>
</dd>
<dt>Examples</dt>
<dd>
<dl class="code-examples">
<dt><code>//MethodCall[pmd-java:matchesSig("_#equals(java.lang.Object)")]</code></dt>
<dd>Matches calls to the method <code>equals</code> on any receiver type</dd>
<dt><code>//MethodCall[pmd-java:matchesSig("java.lang.Enum#equals(java.lang.Object)")]</code></dt>
<dd>Matches calls to the method <code>equals</code> on receiver that is a subtype of Enum</dd>
<dt><code>//MethodCall[pmd-java:matchesSig("java.lang.String#toString()")]</code></dt>
<dd>Matches calls to the method <code>toString</code> on String receivers</dd>
<dt><code>//MethodCall[pmd-java:matchesSig("_#_(int,int)")]</code></dt>
<dd>Matches calls to any method with 2 <code>int</code> parameters (!= argument)</dd>
<dt><code>//ConstructorCall[pmd-java:matchesSig("java.util.ArrayList#new(int)")]</code></dt>
<dd>Matches constructors calls of ArrayList with a single int parameter</dd>
</dl>
</dd>
</dl>
</div>
</div>
</div>
</td>
</tr>
</table>