The interfaces of the Java Collections Framework [JCF 2014] use generically typed, parameterized methods, such as add(E e)
and put(K key, V value)
, to insert objects into the collection or map, but they have other methods, such as contains()
, remove()
, or get()
, that accept an argument of type Object
rather than a parameterized type. Consequently, these methods accept an object of any type. The collections framework interfaces were designed in this manner to maximize backwards compatibility, but this design can also lead to coding errors. Programmers must ensure that arguments passed to methods such as Map<K,V>
get()
, Collection<E>
contains()
, and remove()
have the same type as the parameterized type of the corresponding class instance.
...
Passing arguments to certain Java Collection Framework methods that are of a different type from that of the class instance can cause silent failures, resulting in unintended object retention, memory leaks, or incorrect program operation [Techtalk 2007].
Rule | Severity | Likelihood | Remediation Cost | Priority | Level |
---|---|---|---|---|---|
EXP04-J | Low | Probable | Low | P6 | L2 |
...
Detection of invocations of Collection.remove()
whose operand fails to match the type of the elements of the underlying collection is straightforward. It is possible, although unlikely, that some of these invocations could be intended. The remainder are heuristically likely to be in error. Automated detection for other APIs could be possible.
Bibliography
[JCF 2014] | The Java Collections Framework |
Chapter 5 | |
[JLS 2005] | |
The Joy of Sets |
...