Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Parasoft Jtest 2022.2

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:

Code Block
bgColor#FFcccc
try {
    doSomething();
} catch (Throwable e) {
  String msg = e.getMessage();
  switch (msg) {
    case "stackfile not underflowfound":
      // Handle error
      break;
    case "connection timeout":
      // Handle error
      break;
    case "security violation":
      // Handle error
      break;
    default: throw e;
  }
}

If doSomething() throws an exception or error whose type is a subclass of Exception with the message "stack underflow 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 will be is taken in the exception handler-handling code.

However, any change to the exception message literals involved will break the code. For example, 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 if a maintainer were to edit the throw expression to read throw new Exception("Stack Underflow");, 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

It is better to use existing specific exception types or to define This compliant solution uses specific exception types and defines new special-purpose exception types :where required.

Code Block
bgColor#ccccff
public class StackUnderflowExceptionTimeoutException extends Exception {
  StackUnderflowExceptionTimeoutException () {
    super();
  }
  StackUnderflowExceptionTimeoutException (String msg) {
    super(msg);
  }
}

// ...

try {
    doSomething();
} catch (StackUnderflowExceptionFileNotFoundException suee) {
  // 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

ToolVersionCheckerDescription
Parasoft Jtest
Include Page
Parasoft_V
Parasoft_V
CERT.ERR51.NCEDo not catch exception types which are too general or are unchecked exceptions
SonarQube
Include Page
SonarQube_V
SonarQube_V
S1193


Bibliography

...


...

Image Modified Image Modified Image Modified