Page History

If a finally clause is specified, irrespective Never use 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 block blocks) executes to normal completion or not, . Statements that cause the finally block to complete abruptly also cause the try block to complete abruptly and consequently suppress any exception thrown from the try or catch blocks. 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 reason R, then the finally block is executed.

...

Noncompliant Code Example

...

Then there is a choice:

• If the finally block completes normally, then the try statement completes abruptly for reason R.
• If the finally block completes abruptly for reason S, then the try statement completes abruptly for reason S (and reason R is discarded).

Noncompliant Code Example

In this noncompliant code example, the finally block completes abruptly because of a return statement in the block: abruptly since a return statement occurs within it. As a result, when the exception is thrown in method someException, it does not show up in the output. This is due to the abrupt termination of the finally block that suppresses any useful exception information displayed in the try block by overriding it with its own message. Note that even if the try block returns some value, the finally block is executed.

class SomeExceptionTryFinally extends{
 Exception {private 
static boolean public SomeException(String sdoLogic() { 
    super(s);try {
  }
}

class TryFinally {
  private staticthrow voidnew throwExceptionIllegalStateException() throws SomeException;
    } finally {
    throw new NullPointerException(System.out.println("logic done");
  }
    return true;
    }
  }
}

The IllegalStateException is suppressed by the abrupt completion of the finally block caused by the return statement.

Compliant Solution

This compliant solution removes the return statement from the finally block:

class TryFinally {
  private static private boolean doLogic() {
    try {
      throw new   throwExceptionIllegalStateException();
    } catch (SomeException se) { System.out.println("Exception thrown"); }
  
    finally {
              System.out.println("Uncaughtlogic Exceptiondone");
    }
    // Any return statements must go return true;
    }here; 
  }

  public// staticapplicable void main(String[] args) {
    doLogic();	only when exception is thrown conditionally
  }
}

Compliant Solution

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:This compliant solution removes the return statement from the finally block. Likewise, keywords like break,continue and throw should never be used within a finally block.

class SomeException extends Exception { class TryFinally {
  private static boolean doLogic() {
  public SomeException(String s)try {
 
     throw new superIllegalStateException(s);
  
  }
}

class TryFinally finally {
      int c;
      try {
    private static void throwException() throws SomeException {
    while ((c = input.read()) != -1) {
      throw    newif NullPointerException(c > 128);
  }{
            break;
  static private void doLogic() {
    try {}
        }
  throwException();
    } catch (SomeExceptionIOException sex) { System.out.println("Exception thrown"); }
  
    finally {
        // Forward to handler
      }
        System.out.println("Uncaughtlogic Exceptiondone");
    }
  }

  public static void main(String[] args) {
    doLogic();	  // Any return statements must go here; applicable only when exception is thrown conditionally
  }
}

Risk Assessment

Exiting abruptly from Abrupt completion of a finally block may have unexpected resultsmasks any exceptions thrown inside the associated try and catch blocks.

Automated Detection

...

TODO

Related Vulnerabilities

Search for vulnerabilities resulting from the violation of this rule on the CERT website.

References

Tool	Version	Checker	Description
Coverity	7.5	PW.ABNORMAL_TERMINATION_ OF_FINALLY_BLOCK	Implemented
Klocwork	Include Page Klocwork_V Klocwork_V	JD.FINRET
Parasoft Jtest	Include Page Parasoft_V Parasoft_V	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	Include Page PVS-Studio_V PVS-Studio_V	V6051
SonarQube	Include Page SonarQube_V SonarQube_V	S1143	Jump statements should not occur in "finally" blocks

Related Guidelines

Bibliography

...

Image Added Image Added Image Added Wiki Markup\[[JLS 05|AA. Java References#JLS 05]\] Section 14.20.2, Execution of try-catch-finally \[[Bloch 05|AA. Java References#Bloch 05]\] Puzzle 36: Indecision