Repository navigation
[Java] Question on Overrides of Generic Methods #3490
Description
Description of the issue
https://help.semmle.com/QL/learn-ql/java/types-class-hierarchy.html says:
/** class representing java.util.Collection.toArray(T[]) */ class CollectionToArray extends Method { CollectionToArray() { this.getDeclaringType().hasQualifiedName("java.util", "Collection") and this.hasName("toArray") and this.getNumberOfParameters() = 1 } } /** class representing calls to java.util.Collection.toArray(T[]) */ class CollectionToArrayCall extends MethodAccess { CollectionToArrayCall() { exists(CollectionToArray m | this.getMethod().getSourceDeclaration().overrides*(m) ) } /** the call's actual return type, as determined from its argument */ Array getActualReturnType() { result = this.getArgument(0).getType() } }Notice the use of getSourceDeclaration and overrides in the constructor of CollectionToArrayCall: we want to find calls to Collection.toArray and to any method that overrides it, as well as any parameterized instances of these methods. In our example above, for instance, the call l.toArray resolves to method toArray in the raw class ArrayList.
Running this simple query has zero results.
If the query is modified to not require that the method is declared in a specific type,
it has exactly one result in UniquePropertyMessageEvictionStrategy.java
Question:
Why does the query, that requires the method to be declared in a specific type, not work?
If I understand the documentation correctly, this should work.
Am I misunderstanding what " and to any method that overrides it" means?
Activity
aschackmull commentedon May 22, 2020
Thank you for finding this bug in the tutorial. We'll get that fixed. The TLDR of this is that you can use either
.overridesOrInstantiates*(m)or.getASourceOverriddenMethod*() = min place of.overrides*(m)for this to work properly.The longer explanation of what goes wrong is this:
Consider a class
MyListCollection<E> implements Collection<List<E>>. In this class the methodMyListCollection<E>::toArrayoverridesCollection<List<E>>::toArray, which is is an instantiation ofCollection<T>::toArray(modelled here as the QL classCollectionToArray), so if we only look for straight overrides we won't reachCollectionToArray. This example highlights the issue, but the same thing happens for all other subtypes ofCollection. Take for instanceList<E> extends Collection<E>; againList<E>::toArrayoverridesCollection<E>::toArray, which isn't the same method asCollection<T>::toArraysince one type variable is the one from the definition ofListand the other is the one from the definition ofCollection. I've used the namesEandThere to highlight the difference, but they could equally well both be namedTwithout changing the issue. With all this in mind we could also use yet another (slightly more verbose fix):