When program execution enters a try block that has a finally block, the finally block always executes, regardless of whether the try block (or any associated catch blocks) execute to completion. Statements that cause the finally block to terminate abruptly also cause the try block to terminate abruptly, and consequently mask any exception thrown from the try or catch blocks. Never use return, break, continue or throw statements within a finally block.
Noncompliant Code Example
In this noncompliant code example, the finally block completes abruptly due to a return statement.
...
Consequently, when the IllegalStateException is thrown, it does not propagate all the way up through the call stack. Rather, the abrupt termination of the finally block suppresses the IllegalStateException because it the return statement becomes the final cause of abrupt termination of the try block.
Compliant Solution
This compliant solution removes the return statement from the finally block.
...
In this example, the compiler reports an error because the return statement is unreachable due to the unconditional throwing of IllegalStateException. If the exception were thrown conditionally, the return statement could be used without compilation error.
Risk Assessment
Exiting abruptly from a finally block masks any exceptions thrown inside the associated try and catch blocks.
Guideline | Severity | Likelihood | Remediation Cost | Priority | Level |
|---|---|---|---|---|---|
EXC04-J | low | probable | medium | P4 | L3 |
Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this guideline on the CERT website.
Bibliography
| Wiki Markup |
|---|
\[[Bloch 2005|AA. Bibliography#Bloch 05]\] Puzzle 36: Indecision \[[Chess 2007|AA. Bibliography#Chess 07]\] 8.2 Managing Exceptions, "The Vanishing Exception" \[[JLS 2005|AA. Bibliography#JLS 05]\] [Section 14.20.2, Execution of try-catch-finally|http://java.sun.com/docs/books/jls/third_edition/html/statements.html#14.20.2]\[[MITRE 2009|AA. Bibliography#MITRE 09]\] [CWE ID 705|http://cwe.mitre.org/data/definitions/705.html] "Incorrect Control Flow Scoping", [CWE ID 584|http://cwe.mitre.org/data/definitions/584.html] "Return Inside Finally Block" |
...