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 TypeNameCheckExamplesTest extends AbstractExamplesModuleTestSupport {
29  
30      @Override
31      public String getPackageLocation() {
32          return "com/puppycrawl/tools/checkstyle/checks/naming/typename";
33      }
34  
35      @Test
36      public void testExample1() throws Exception {
37          final String[] expected = {
38              "13:20: " + getCheckMessage(MSG_INVALID_PATTERN, "firstName", "^[A-Z][a-zA-Z0-9]*$"),
39              "15:19: " + getCheckMessage(MSG_INVALID_PATTERN, "Third_Name", "^[A-Z][a-zA-Z0-9]*$"),
40              "16:17: " + getCheckMessage(MSG_INVALID_PATTERN, "FourthName_", "^[A-Z][a-zA-Z0-9]*$"),
41              "17:8: " + getCheckMessage(MSG_INVALID_PATTERN, "Fifth_Name", "^[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              "16:7: " + getCheckMessage(MSG_INVALID_PATTERN, "Example2", "^[a-z](_?[a-zA-Z0-9]+)*$"),
51              "18:16: " + getCheckMessage(MSG_INVALID_PATTERN,
52                      "SecondName", "^[a-z](_?[a-zA-Z0-9]+)*$"),
53              "21:8: " + getCheckMessage(MSG_INVALID_PATTERN,
54                      "Fifth_Name", "^[a-z](_?[a-zA-Z0-9]+)*$"),
55          };
56  
57          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
58      }
59  
60      @Test
61      public void testExample3() throws Exception {
62          final String[] expected = {
63              "18:20: " + getCheckMessage(MSG_INVALID_PATTERN, "firstName", "^I_[a-zA-Z0-9]*$"),
64          };
65  
66          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
67      }
68  
69      @Test
70      public void testExample4() throws Exception {
71          final String[] expected = {
72              "19:19: " + getCheckMessage(MSG_INVALID_PATTERN,
73                      "Third_Name", "^[a-z](_?[a-zA-Z0-9]+)*$"),
74              "20:17: " + getCheckMessage(MSG_INVALID_PATTERN,
75                          "FourthName_", "^[a-z](_?[a-zA-Z0-9]+)*$"),
76          };
77  
78          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
79      }
80  
81      @Test
82      public void testExample5() throws Exception {
83          final String[] expected = {
84              "17:16: " + getCheckMessage(MSG_INVALID_PATTERN,
85                      "SecondName", "^[a-z](_?[a-zA-Z0-9]+)*$"),
86              "18:19: " + getCheckMessage(MSG_INVALID_PATTERN,
87                      "Third_Name", "^[a-z](_?[a-zA-Z0-9]+)*$"),
88              "19:17: " + getCheckMessage(MSG_INVALID_PATTERN,
89                      "FourthName_", "^[a-z](_?[a-zA-Z0-9]+)*$"),
90          };
91  
92          verifyWithInlineConfigParser(getPath("Example5.java"), expected);
93      }
94  
95      @Test
96      public void testExample6() throws Exception {
97          final String[] expected = {
98              "20:8: " + getCheckMessage(MSG_INVALID_PATTERN,
99                      "Fifth_Name", "^[a-z](_?[a-zA-Z0-9]+)*$"),
100         };
101 
102         verifyWithInlineConfigParser(getPath("Example6.java"), expected);
103     }
104 
105     @Test
106     public void testExample7() throws Exception {
107         final String[] expected = {
108             "15:7: " + getCheckMessage(MSG_INVALID_PATTERN,
109                     "Example7", "^[a-z](_?[a-zA-Z0-9]+)*$"),
110             "17:16: " + getCheckMessage(MSG_INVALID_PATTERN,
111                     "SecondName", "^[a-z](_?[a-zA-Z0-9]+)*$"),
112             "18:19: " + getCheckMessage(MSG_INVALID_PATTERN,
113                     "Third_Name", "^[a-z](_?[a-zA-Z0-9]+)*$"),
114             "19:17: " + getCheckMessage(MSG_INVALID_PATTERN,
115                     "FourthName_", "^[a-z](_?[a-zA-Z0-9]+)*$"),
116         };
117 
118         verifyWithInlineConfigParser(getPath("Example7.java"), expected);
119     }
120 
121 }