File: OrphanedFormatString.md

package info (click to toggle)
error-prone-java 2.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 15,076 kB
  • sloc: java: 171,398; xml: 1,459; sh: 34; makefile: 7
file content (25 lines) | stat: -rw-r--r-- 712 bytes parent folder | download
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
Passing a string that contains format specifiers to a method that does not
perform string formatting is usually a mistake.

Do this:

```java
if (!isValid(arg)) {
  throw new IllegalArgumentException(String.format("invalid arg: %s", arg));
}
```

Not this:

```java
if (!isValid(arg)) {
  throw new IllegalArgumentException("invalid arg: %s");
}
```

If the method you're calling actually accepts a format string, you can annotate
that method with [`@FormatMethod`][fm] to ensure that callers correctly pass
format strings (and to inform Error Prone that the method call you're making
doesn't orphan a format string).

[fm]: https://errorprone.info/api/latest/com/google/errorprone/annotations/FormatMethod.html