com.github.sevntu.checkstyle.checks.coding

Class AvoidHidingCauseExceptionCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.github.sevntu.checkstyle.checks.coding.AvoidHidingCauseExceptionCheck

All Implemented Interfaces:

com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public class AvoidHidingCauseExceptionCheck
extends com.puppycrawl.tools.checkstyle.api.AbstractCheck

This check prevents new exception throwing inside try/catch blocks without providing current exception cause. New exception should propagate up to a higher-level handler with exact cause to provide a full stack trace for the problem.

Rationale: When handling exceptions using try/catch blocks junior developers may lose the original/cause exception object and information associated with it.

Examples:

1. Cause exception will be lost because current catch block contains another exception throwing.

       public void foo() {
          RuntimeException r;
         catch (java.lang.Exception e) {
           //your code
           throw r;
         }
       }

2. Cause exception will be lost because current catch block doesn`t contains another exception throwing.

      catch (IllegalStateException e) {
        //your code
        throw new RuntimeException();
      }
      catch (IllegalStateException e) {
        //your code
        throw new RuntimeException("Runtime Exception!");
      }
 

Since:

1.8.0

Author:

Daniil Yaroslavtsev, Ilja Dubinin

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_KEY A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
AvoidHidingCauseExceptionCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens()
int[]	getDefaultTokens()
int[]	getRequiredTokens()
void	visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST detailAST)

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

beginTree, clearViolations, destroy, finishTree, getFileContents, getLine, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MSG_KEY

public static final String MSG_KEY

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

AvoidHidingCauseExceptionCheck

public AvoidHidingCauseExceptionCheck()

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

Specified by:

getDefaultTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

getAcceptableTokens

public int[] getAcceptableTokens()

Specified by:

getAcceptableTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

getRequiredTokens

public int[] getRequiredTokens()

Specified by:

getRequiredTokens in class com.puppycrawl.tools.checkstyle.api.AbstractCheck

visitToken

public void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST detailAST)

Overrides:

visitToken in class com.puppycrawl.tools.checkstyle.api.AbstractCheck