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