com.github.sevntu.checkstyle.checks.coding

Class ForbidReturnInFinallyBlockCheck

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.ForbidReturnInFinallyBlockCheck

All Implemented Interfaces:

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

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

The finally block is always executed unless there is abnormal program termination, either resulting from a JVM crash or from a call to System.exit(0). On top of that, any value returned from within the finally block will override the value returned prior to execution of the finally block. This check reports if the finally block contains a return statement.

Since:

1.13.0

Author:

Andrew Uljanenko

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
ForbidReturnInFinallyBlockCheck()

Method Summary

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

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

beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, 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

ForbidReturnInFinallyBlockCheck

public ForbidReturnInFinallyBlockCheck()

Method Detail

getDefaultTokens

public final 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 finallyNode)

Overrides:

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