errorprone.bugpattern.CheckedExceptionNotThrown.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-erroraway-sonar-plugin Show documentation

The newest version!

Java allows methods to declare that they throw checked exceptions even when they
don't. This can lead to call sites being forced to explicitly handle or
propagate exceptions which provably can never occur. It may also lead readers of
the code to search for possibly throwing paths where none exist.

```java
private static void validateRequest(Request request) throws IOException {
  checkArgument(request.hasFoo(), "foo must be specified");
}

Response handle(Request request) {
  try {
    validateRequest(request);
  } catch (IOException e) { // Required, but unreachable.
    return failedResponse();
  }
  // ...
}
```

Including unthrown exceptions can be reasonable where the method is overridable,
as overriding methods will not be able to declare that they throw any exceptions
not included.