View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2026 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ///////////////////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle.checks.naming;
21  
22  import static com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck.MSG_INVALID_PATTERN;
23  
24  import org.junit.jupiter.api.Test;
25  
26  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
27  
28  public class LocalFinalVariableNameCheckExamplesTest extends AbstractExamplesModuleTestSupport {
29  
30      @Override
31      public String getPackageLocation() {
32          return "com/puppycrawl/tools/checkstyle/checks/naming/localfinalvariablename";
33      }
34  
35      @Test
36      public void testExample1() throws Exception {
37          final String[] expected = {
38              "18:17: " + getCheckMessage(
39                      MSG_INVALID_PATTERN, "VAR1", "^([a-z][a-zA-Z0-9]*|_)$"),
40              "23:17: " + getCheckMessage(
41                      MSG_INVALID_PATTERN, "VAR2", "^([a-z][a-zA-Z0-9]*|_)$"),
42          };
43  
44          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
45      }
46  
47      @Test
48      public void testExample2() throws Exception {
49          final String[] expected = {
50              "20:17: " + getCheckMessage(MSG_INVALID_PATTERN, "VAR1",
51                      "^[a-z][a-zA-Z0-9]{4,}$"),
52              "21:17: " + getCheckMessage(MSG_INVALID_PATTERN, "var1",
53                      "^[a-z][a-zA-Z0-9]{4,}$"),
54              "23:28: " + getCheckMessage(MSG_INVALID_PATTERN, "ex",
55                      "^[a-z][a-zA-Z0-9]{4,}$"),
56              "25:17: " + getCheckMessage(MSG_INVALID_PATTERN, "VAR2",
57                      "^[a-z][a-zA-Z0-9]{4,}$"),
58              "26:17: " + getCheckMessage(MSG_INVALID_PATTERN, "var2",
59                      "^[a-z][a-zA-Z0-9]{4,}$"),
60          };
61  
62          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
63      }
64  
65      @Test
66      public void testExample3() throws Exception {
67          final String[] expected = {
68              "19:18: " + getCheckMessage(MSG_INVALID_PATTERN, "scanner", "^[A-Z][A-Z0-9]*$"),
69              "24:28: " + getCheckMessage(MSG_INVALID_PATTERN, "ex", "^[A-Z][A-Z0-9]*$"),
70          };
71  
72          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
73      }
74  
75      @Test
76      public void testUseCase1() throws Exception {
77          final String[] expected = {
78              "18:18: " + getCheckMessage(MSG_INVALID_PATTERN, "scanner", "^[A-Z][A-Z0-9]*$"),
79              "21:17: " + getCheckMessage(MSG_INVALID_PATTERN, "var1", "^[A-Z][A-Z0-9]*$"),
80              "23:28: " + getCheckMessage(MSG_INVALID_PATTERN, "ex", "^[A-Z][A-Z0-9]*$"),
81              "26:17: " + getCheckMessage(MSG_INVALID_PATTERN, "var2", "^[A-Z][A-Z0-9]*$"),
82          };
83  
84          verifyWithInlineConfigParser(getPath("UseCase1.java"), expected);
85      }
86  
87  }