Skip to content

Commit 9f79a39

Browse files
authored
Merge pull request #17026 from Marcono1234/patch-1
Java: Update `Annotation` predicate examples in language guide
2 parents eaf2949 + 6d468c1 commit 9f79a39

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/codeql/codeql-language-guides/annotations-in-java.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ As a first step, let's write a query that finds all ``@Override`` annotations. A
103103
104104
As always, it is a good idea to try this query on a CodeQL database for a Java/Kotlin project to make sure it actually produces some results. On the earlier example, it should find the annotation on ``Sub1.m``. Next, we encapsulate the concept of an ``@Override`` annotation as a CodeQL class:
105105

106-
::
106+
.. code-block:: ql
107107
108108
class OverrideAnnotation extends Annotation {
109109
OverrideAnnotation() {
@@ -213,11 +213,11 @@ To do so, we first introduce a class for representing all ``@SuppressWarnings``
213213
class SuppressDeprecationWarningAnnotation extends Annotation {
214214
SuppressDeprecationWarningAnnotation() {
215215
this.getType().hasQualifiedName("java.lang", "SuppressWarnings") and
216-
this.getAValue().(Literal).getLiteral().regexpMatch(".*deprecation.*")
216+
this.getAStringArrayValue("value").regexpMatch(".*deprecation.*")
217217
}
218218
}
219219
220-
Here, we use ``getAValue()`` to retrieve any annotation value: in fact, annotation type ``SuppressWarnings`` only has a single annotation element, so every ``@SuppressWarnings`` annotation only has a single annotation value. Then, we ensure that it is a literal, obtain its string value using ``getLiteral``, and check whether it contains the string ``deprecation`` using a regular expression match.
220+
Here, we use ``getAStringArrayValue("value")`` to retrieve any of the suppressed warnings: ``@SuppressWarnings`` defines the warnings to suppress using the annotation element named ``value`` of type ``String[]``, and ``getAStringArrayValue`` retrieves all of the array values; the CodeQL class ``Annotation`` also has similar convenience predicates for the other possible annotation element types. Afterwards we check whether one of the values is the string ``deprecation`` using a regular expression match.
221221

222222
For real-world use, this check would have to be generalized a bit: for example, the OpenJDK Java compiler allows ``@SuppressWarnings("all")`` annotations to suppress all warnings. We may also want to make sure that ``deprecation`` is matched as an entire word, and not as part of another word, by changing the regular expression to ``".*\\bdeprecation\\b.*"``.
223223

0 commit comments

Comments
 (0)