com.github.sevntu.checkstyle.checks.coding

Class RedundantReturnCheck

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

All Implemented Interfaces:

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

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

Highlights usage of redundant returns inside constructors and methods with void result.

For example:

1. Non-empty constructor

    public HelloWorld(){
        doStuff();
        return;
    }

2. Method with void result

    public void testMethod1(){
        doStuff();
        return;
    }

However, if your IDE does not support breakpoints on the method entry, you can allow the use of redundant returns in constructors and methods with void result without code except for 'return;'.

For example:

1. Empty constructor

    public HelloWorld(){
        return;
    }

2. Method with void result and empty body

    public void testMethod1(){
        return;
    }

Since:

1.8.0

Author:

Troshin Sergey, Max Vetrenko, Alexey Nesterenko

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

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens()
int[]	getDefaultTokens()
int[]	getRequiredTokens()
void	setAllowReturnInEmptyMethodsAndConstructors(boolean allowEmptyBlocks) Setter for allowReturnInEmptyMethodsAndConstructors.
void	visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST ast)

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

RedundantReturnCheck

public RedundantReturnCheck()

Method Detail

setAllowReturnInEmptyMethodsAndConstructors

public void setAllowReturnInEmptyMethodsAndConstructors(boolean allowEmptyBlocks)

Setter for allowReturnInEmptyMethodsAndConstructors.

Parameters:

allowEmptyBlocks - allow 'return' in empty constructors and methods that return void.

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 ast)

Overrides:

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