File: TypeNameShadowing.md

package info (click to toggle)
error-prone-java 2.18.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 23,204 kB
  • sloc: java: 222,992; xml: 1,319; sh: 25; makefile: 7
file content (25 lines) | stat: -rw-r--r-- 795 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
When declaring type parameters, it's possible to declare a type parameter with
the same name as another type in scope, "shadowing" that type and potentially
causing confusing or unintended behavior.

```java
class Bar {
  ...
  public void doSomething(T object) {
    // Here, object is the static class T in this file
  }

  public <T> void doSomethingElse(T object) {
    // Here, object is a generic T
  }
  ...
  public static class T {...}
}
```

This checker warns when a type parameter shadows another type and suggests a
possible renaming for the type parameter.

Note, however, that in some cases it may be preferable to rename or delete the
shadowed type rather than the type parameter shadowing it, such as in cases
where the type parameter is always instantiated with the same type.