Because an exception is caught by its type, it is better to define exceptions for specific purposes than to use the general exception types for multiple purposes. Throwing the general exception types makes code hard to understand and maintain , and defeats much of the advantage of the Java exception-handling mechanism.
Noncompliant Code Example
This noncompliant code example attempts to distinguish between different exceptional behaviors by looking at the exception's message:
...
If doSomething()
throws an exception or error whose type is a subclass of Throwable
, the switch statement allows selection of a specific case to execute. For example, if the exception message is "file not found," the appropriate action is taken in the exception-handling code.
However, any change to the exception message literals involved will break the code. For example, if a maintainer were to edit the throw expression to read throw new suppose this code is executed:
Code Block |
---|
throw new Exception("cannot find file |
...
"); |
This exception should be handled by the first case clause, but it will be rethrown because the string does not match any case clause.
Furthermore, the exception would be rethrown by the code of the noncompliant code example rather than handled. Finally, exceptions may be thrown without a message.
This noncompliant code example falls under ERR08-J-EX0 of rule ERR08-J. Do not catch NullPointerException or any of its ancestors because it catches general exceptions but rethrows them.
Compliant Solution
This compliant solution uses specific exception types and defines new special-purpose exception types where required.
Code Block | ||
---|---|---|
| ||
public class TimeoutException extends Exception { TimeoutException () { super(); } TimeoutException (String msg) { super(msg); } } // ... try { doSomething(); } catch (FileNotFoundException e) { // Handle error } catch (TimeoutException te) { // Handle error } catch (SecurityException se) { // Handle error } |
Applicability
Exceptions are used to handle exceptional conditions. If an exception is not caught, the program thread will be terminated, which may cause the program to exit. An exception that is incorrectly caught or is caught at the wrong level of recovery will often cause incorrect behavior.
Automated Detection
Tool | Version | Checker | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
Parasoft Jtest |
| CERT.ERR51.NCE | Do not catch exception types which are too general or are unchecked exceptions | ||||||
SonarQube |
| S1193 |
Bibliography
...
...