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.ParameterNameCheck.MSG_INVALID_PATTERN;
23  
24  import org.junit.jupiter.api.Test;
25  
26  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
27  
28  public class ParameterNameCheckExamplesTest extends AbstractExamplesModuleTestSupport {
29      @Override
30      public String getPackageLocation() {
31          return "com/puppycrawl/tools/checkstyle/checks/naming/parametername";
32      }
33  
34      @Test
35      public void testExample1() throws Exception {
36          final String[] expected = {
37              "15:20: " + getCheckMessage(MSG_INVALID_PATTERN, "V2", "^[a-z][a-zA-Z0-9]*$"),
38              "17:32: " + getCheckMessage(MSG_INVALID_PATTERN, "V3", "^[a-z][a-zA-Z0-9]*$"),
39          };
40  
41          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
42      }
43  
44      @Test
45      public void testExample2() throws Exception {
46          final String[] expected = {
47              "15:20: " + getCheckMessage(MSG_INVALID_PATTERN, "v", "^[a-z][_a-zA-Z0-9]+$"),
48              "17:20: " + getCheckMessage(MSG_INVALID_PATTERN, "V2", "^[a-z][_a-zA-Z0-9]+$"),
49              "19:32: " + getCheckMessage(MSG_INVALID_PATTERN, "V3", "^[a-z][_a-zA-Z0-9]+$"),
50          };
51  
52          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
53      }
54  
55      @Test
56      public void testExample3() throws Exception {
57          final String[] expected = {
58              "17:20: " + getCheckMessage(MSG_INVALID_PATTERN, "V2", "^[a-z][a-zA-Z0-9]*$"),
59          };
60  
61          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
62      }
63  
64      @Test
65      public void testExample4() throws Exception {
66          final String[] expected = {
67              "15:20: " + getCheckMessage(MSG_INVALID_PATTERN, "v", "^[a-z][a-zA-Z0-9]+$"),
68              "17:20: " + getCheckMessage(MSG_INVALID_PATTERN, "V2", "^[a-z][a-zA-Z0-9]+$"),
69              "19:32: " + getCheckMessage(MSG_INVALID_PATTERN, "V3", "^[a-z][a-zA-Z0-9]+$"),
70          };
71  
72          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
73      }
74  
75      @Test
76      public void testExample5() throws Exception {
77          final String[] expected = {
78              "26:20: Parameter name 'V2' must match pattern "
79                  + "'^[a-z]([a-z0-9][a-zA-Z0-9]*)?$'",
80              "28:32: Parameter name 'V3' must match pattern "
81                  + "'^[a-z][a-z0-9][a-zA-Z0-9]*$'",
82          };
83  
84          verifyWithInlineConfigParser(getPath("Example5.java"), expected);
85      }
86  }