File: NonFinalCompileTimeConstant.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 (12 lines) | stat: -rw-r--r-- 499 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
If a method's formal parameter is annotated with `@CompileTimeConstant`, the
method will always be invoked with an argument that is a static constant. If the
parameter itself is non-final, then it is a mutable reference to immutable data.
This is rarely useful, and can be confusing when trying to use the parameter in
a context that requires an compile-time constant. For example:

```java
void f(@CompileTimeConstant y) {}
void g(@CompileTimeConstant x) {
  x = f(x); // x is not a constant
}
```