Never use {{ Wiki Markup return
}}, {{break
}}, {{continue
}}, or {{throw
}} statements within a {{finally
}} block. 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) executes to normal completion. Statements that cause the {{finally
}} block to terminate complete abruptly also cause the {{try
}} block to terminate complete abruptly and consequently suppress any exception thrown from the {{try
}} or {{catch
}} blocks \[[JLS 2005|http://java.sun.com/docs/books/jls/third_edition/html/statements.html#14.20.2]\]. According to The Java Language Specification, §14.20.2, "Execution of try-finally
and try-catch-finally
" [JLS 2015]:
If execution of the
try
block completes abruptly for any other reasonR
, then thefinally
block is executed. Then there is a choice:
- If the
finally
block completes normally, then thetry
statement completes abruptly for reasonR
.- If the
finally
block completes abruptly for reasonS
, then thetry
statement completes abruptly for reasonS
(and reasonR
is discarded).
Noncompliant Code Example
In this noncompliant code example, the finally
block completes abruptly because of a return
statement in the block.:
Code Block | ||
---|---|---|
| ||
class TryFinally {
private static boolean doLogic() {
try {
throw new IllegalStateException();
} finally {
System.out.println("logic done");
return true;
}
}
}
|
The IllegalStateException
is suppressed by the abrupt termination completion of the finally
block caused by the return
statement.
Compliant Solution
This compliant solution removes the return
statement from the finally
block.:
Code Block | ||
---|---|---|
| ||
class TryFinally {
private static boolean doLogic() {
try {
throw new IllegalStateException();
} finally {
System.out.println("logic done");
}
// Any return statements must go here;
// applicable only when exception is thrown conditionally
}
}
|
Exceptions
ERRO4-J-EX0: Control flow statements whose destination is within the finally
block are perfectly acceptable. For example, the following code does not violate this rule , because the break
statement exits within the while
loop , but not within the finally
block.:
Code Block | ||
---|---|---|
| ||
class TryFinally { private static boolean doLogic() { try { throw new IllegalStateException(); } finally { int c; try { while ((c = input.read()) != -1) { if (c > 128) { break; } } } catch (IOException x) { // forwardForward to handler } System.out.println("logic done"); } // Any return statements must go here; applicable only when exception is thrown conditionally } } |
Risk Assessment
Exiting abruptly from Abrupt completion of a finally
block masks any exceptions thrown inside the associated try
and catch
blocks.
Rule | Severity | Likelihood | Remediation Cost | Priority | Level |
---|---|---|---|---|---|
ERR04-J |
Low |
Probable |
Medium | P4 | L3 |
Automated Detection
Tool | Version | Checker | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
Coverity | 7.5 | PW.ABNORMAL_TERMINATION_ OF_FINALLY_BLOCK | Implemented | ||||||
Parasoft Jtest |
| CERT.ERR04.ARCF CERT.ERR04.ATSF | Avoid using 'return's inside 'finally blocks if thare are other 'return's inside the try-catch block Do not exit "finally" blocks abruptly | ||||||
PVS-Studio |
| V6051 | |||||||
SonarQube |
| S1143 | Jump statements should not occur in "finally" blocks |
Related Guidelines
Bibliography
Block |
Bibliography
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1ae97486-1a8f-4634-a9a2-53f2324a483e"><ac:plain-text-body><![CDATA[
[[Bloch 2005
AA. Bibliography#Bloch 05]]
Puzzle 36. Indecision
]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="5352c3b7-05d0-4e00-a478-299f8fa0afd3"><ac:plain-text-body><![CDATA[
[[Chess 2007
AA. Bibliography#Chess 07]]
8.2, Managing Exceptions, The Vanishing Exception
]]></ac:plain-text-body></ac:structured-macro>
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="55548c65-e3ba-4d96-877b-4fd49dc35864"><ac:plain-text-body><![CDATA[
[[JLS 2005
AA. Bibliography#JLS 05]]
Puzzle 36. Indecision | |
Section 8.2, "Managing Exceptions, The Vanishing Exception" | |
[JLS 2015] |
http://java.sun.com/docs/books/jls/third_edition/html/statements.html#14.20.2]
]]></ac:plain-text-body></ac:structured-macro>
...