pmd/docs/_data/xpath_funs.yml

langs:
  - name: "Java"
    ns: "pmd-java"
    funs:
      - name: typeIs
        returnType: "xs:boolean"
        description: "Returns true if the context node's static type is a subtype of the given type"
        notes: "The context node must be a {% jdoc jast::TypeNode %}"
        parameters:
          - name: javaQualifiedName
            type: "xs:string"
            description: "the qualified name of a class, possibly with pairs of brackets to indicate an array type.
              Can also be a primitive type name."

      - name: typeIsExactly
        returnType: "xs:boolean"
        description: "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."
        notes_are_same_as: typeIs
        params_are_same_as: typeIs

      - name: metric
        returnType: "xs:decimal?"
        description: "Returns the value of the metric as evaluated on the context node"
        notes: "The context node must be a {% jdoc jast::ASTAnyTypeDeclaration %} or a {% jdoc jast::MethodLikeNode %}"
        parameters:
          - name: "metricKey"
            type: "xs:string"
            description: "The name of an enum constant in {% jdoc jmx::api.JavaOperationMetricKey %} or {% jdoc jmx::api.JavaClassMetricKey %}"

    examples:
      - code: '//FormalParameter[pmd-java:typeIs("java.lang.String[]")]'
        outcome: "Matches formal parameters of type `String[]` (including vararg parameters)"
      - code: '//VariableDeclaratorId[pmd-java:typeIs("java.lang.List")]'
        outcome: "Matches variable declarators of type `List` or any of its subtypes (including e.g. `ArrayList`)"
      - code: '//VariableDeclaratorId[pmd-java:typeIsExactly("java.lang.List")]'
        outcome: "Matches variable declarators of type `List` (but not e.g. `ArrayList`)"