• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License").
5  * You may not use this file except in compliance with the License.
6  * A copy of the License is located at
7  *
8  *  http://aws.amazon.com/apache2.0
9  *
10  * or in the "license" file accompanying this file. This file is distributed
11  * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12  * express or implied. See the License for the specific language governing
13  * permissions and limitations under the License.
14  */
15 
16 package software.amazon.awssdk.buildtools.checkstyle;
17 
18 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
19 import com.puppycrawl.tools.checkstyle.api.DetailAST;
20 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
21 import com.puppycrawl.tools.checkstyle.utils.ScopeUtil;
22 
23 /**
24  * A rule that disallows unnecessary 'final' on local variables
25  */
26 public class UnnecessaryFinalOnLocalVariableCheck extends AbstractCheck {
27 
28     @Override
getDefaultTokens()29     public int[] getDefaultTokens() {
30         return getRequiredTokens();
31     }
32 
33     @Override
getAcceptableTokens()34     public int[] getAcceptableTokens() {
35         return getRequiredTokens();
36     }
37 
38     @Override
getRequiredTokens()39     public int[] getRequiredTokens() {
40         return new int[] { TokenTypes.VARIABLE_DEF };
41     }
42 
43     @Override
visitToken(DetailAST ast)44     public void visitToken(DetailAST ast) {
45         if (ScopeUtil.isLocalVariableDef(ast) && ast.findFirstToken(TokenTypes.MODIFIERS)
46                                                     .findFirstToken(TokenTypes.FINAL) != null) {
47             log(ast, "final should be removed from local variable");
48         }
49     }
50 }
51