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 StaticVariableNameCheckExamplesTest extends AbstractExamplesModuleTestSupport {
29  
30      public static final String STATIC_VAR_NAME_PATTERN_1 = "^[a-z][a-zA-Z0-9]*$";
31      public static final String STATIC_VAR_NAME_PATTERN_2 = "^[a-z](_?[a-zA-Z0-9]+)*$";
32  
33      @Override
34      public String getPackageLocation() {
35          return "com/puppycrawl/tools/checkstyle/checks/naming/staticvariablename";
36      }
37  
38      @Test
39      public void testExample1() throws Exception {
40          final String[] expected = {
41              "19:21: " + getCheckMessage(MSG_INVALID_PATTERN,
42                      "ItStatic1", STATIC_VAR_NAME_PATTERN_1),
43              "20:24: " + getCheckMessage(MSG_INVALID_PATTERN,
44                      "ItStatic2", STATIC_VAR_NAME_PATTERN_1),
45              "21:22: " + getCheckMessage(MSG_INVALID_PATTERN,
46                      "ItStatic", STATIC_VAR_NAME_PATTERN_1),
47              "22:21: " + getCheckMessage(MSG_INVALID_PATTERN,
48                      "it_static", STATIC_VAR_NAME_PATTERN_1),
49              "23:21: " + getCheckMessage(MSG_INVALID_PATTERN,
50                      "It_Static", STATIC_VAR_NAME_PATTERN_1),
51              "24:22: " + getCheckMessage(MSG_INVALID_PATTERN,
52                      "It_Static1", STATIC_VAR_NAME_PATTERN_1),
53              "25:14: " + getCheckMessage(MSG_INVALID_PATTERN,
54                      "It_Static2", STATIC_VAR_NAME_PATTERN_1),
55          };
56  
57          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
58      }
59  
60      @Test
61      public void testExample2() throws Exception {
62          final String[] expected = {
63              "19:21: " + getCheckMessage(MSG_INVALID_PATTERN,
64                      "ItStatic1", STATIC_VAR_NAME_PATTERN_2),
65              "20:24: " + getCheckMessage(MSG_INVALID_PATTERN,
66                      "ItStatic2", STATIC_VAR_NAME_PATTERN_2),
67              "21:22: " + getCheckMessage(MSG_INVALID_PATTERN,
68                      "ItStatic", STATIC_VAR_NAME_PATTERN_2),
69              "23:21: " + getCheckMessage(MSG_INVALID_PATTERN,
70                      "It_Static", STATIC_VAR_NAME_PATTERN_2),
71              "24:22: " + getCheckMessage(MSG_INVALID_PATTERN,
72                      "It_Static1", STATIC_VAR_NAME_PATTERN_2),
73              "25:14: " + getCheckMessage(MSG_INVALID_PATTERN,
74                      "It_Static2", STATIC_VAR_NAME_PATTERN_2),
75          };
76  
77          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
78      }
79  
80      @Test
81      public void testExample3() throws Exception {
82          final String[] expected = {
83              "20:24: " + getCheckMessage(MSG_INVALID_PATTERN,
84                      "ItStatic2", STATIC_VAR_NAME_PATTERN_1),
85              "21:22: " + getCheckMessage(MSG_INVALID_PATTERN,
86                      "ItStatic", STATIC_VAR_NAME_PATTERN_1),
87              "24:22: " + getCheckMessage(MSG_INVALID_PATTERN,
88                      "It_Static1", STATIC_VAR_NAME_PATTERN_1),
89              "25:14: " + getCheckMessage(MSG_INVALID_PATTERN,
90                      "It_Static2", STATIC_VAR_NAME_PATTERN_1),
91          };
92  
93          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
94      }
95  
96      @Test
97      public void testExample4() throws Exception {
98          final String[] expected = {
99              "19:21: " + getCheckMessage(MSG_INVALID_PATTERN,
100                     "ItStatic1", STATIC_VAR_NAME_PATTERN_1),
101             "21:22: " + getCheckMessage(MSG_INVALID_PATTERN,
102                     "ItStatic", STATIC_VAR_NAME_PATTERN_1),
103             "22:21: " + getCheckMessage(MSG_INVALID_PATTERN,
104                     "it_static", STATIC_VAR_NAME_PATTERN_1),
105             "23:21: " + getCheckMessage(MSG_INVALID_PATTERN,
106                     "It_Static", STATIC_VAR_NAME_PATTERN_1),
107             "24:22: " + getCheckMessage(MSG_INVALID_PATTERN,
108                     "It_Static1", STATIC_VAR_NAME_PATTERN_1),
109             "25:14: " + getCheckMessage(MSG_INVALID_PATTERN,
110                     "It_Static2", STATIC_VAR_NAME_PATTERN_1),
111         };
112 
113         verifyWithInlineConfigParser(getPath("Example4.java"), expected);
114     }
115 
116     @Test
117     public void testExample5() throws Exception {
118         final String[] expected = {
119             "19:21: " + getCheckMessage(MSG_INVALID_PATTERN,
120                     "ItStatic1", STATIC_VAR_NAME_PATTERN_1),
121             "20:24: " + getCheckMessage(MSG_INVALID_PATTERN,
122                     "ItStatic2", STATIC_VAR_NAME_PATTERN_1),
123             "22:21: " + getCheckMessage(MSG_INVALID_PATTERN,
124                     "it_static", STATIC_VAR_NAME_PATTERN_1),
125             "23:21: " + getCheckMessage(MSG_INVALID_PATTERN,
126                     "It_Static", STATIC_VAR_NAME_PATTERN_1),
127             "25:14: " + getCheckMessage(MSG_INVALID_PATTERN,
128                     "It_Static2", STATIC_VAR_NAME_PATTERN_1),
129         };
130 
131         verifyWithInlineConfigParser(getPath("Example5.java"), expected);
132     }
133 
134     @Test
135     public void testExample6() throws Exception {
136         final String[] expected = {
137             "19:21: " + getCheckMessage(MSG_INVALID_PATTERN,
138                     "ItStatic1", STATIC_VAR_NAME_PATTERN_1),
139             "20:24: " + getCheckMessage(MSG_INVALID_PATTERN,
140                     "ItStatic2", STATIC_VAR_NAME_PATTERN_1),
141             "21:22: " + getCheckMessage(MSG_INVALID_PATTERN,
142                     "ItStatic", STATIC_VAR_NAME_PATTERN_1),
143             "22:21: " + getCheckMessage(MSG_INVALID_PATTERN,
144                     "it_static", STATIC_VAR_NAME_PATTERN_1),
145             "23:21: " + getCheckMessage(MSG_INVALID_PATTERN,
146                     "It_Static", STATIC_VAR_NAME_PATTERN_1),
147             "24:22: " + getCheckMessage(MSG_INVALID_PATTERN,
148                     "It_Static1", STATIC_VAR_NAME_PATTERN_1),
149         };
150 
151         verifyWithInlineConfigParser(getPath("Example6.java"), expected);
152     }
153 
154 }