Skip to content

Commit 0054bd0

Browse files
authored
Java: Update Annotation predicate examples in language guide
1 parent 38aac1f commit 0054bd0

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -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 as ``String[]``, and ``getAStringArrayValue`` retrieves all of the array elements; the CodeQL ``Annotation`` also has similar convenience predicates for the other possible annotation element types. Afterwards we check whether one of the elements 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)