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.AbstractClassNameCheck.MSG_ILLEGAL_ABSTRACT_CLASS_NAME;
23  import static com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck.MSG_NO_ABSTRACT_CLASS_MODIFIER;
24  
25  import org.junit.jupiter.api.Test;
26  
27  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
28  
29  public class AbstractClassNameCheckExamplesTest extends AbstractExamplesModuleTestSupport {
30  
31      private static final String DEFAULT_PATTERN = "^Abstract.+$";
32  
33      @Override
34      public String getPackageLocation() {
35          return "com/puppycrawl/tools/checkstyle/checks/naming/abstractclassname";
36      }
37  
38      @Test
39      public void testExample1() throws Exception {
40          final String[] expected = {
41              "16:3: " + getCheckMessage(MSG_ILLEGAL_ABSTRACT_CLASS_NAME, "Second", DEFAULT_PATTERN),
42              "17:3: " + getCheckMessage(MSG_NO_ABSTRACT_CLASS_MODIFIER, "AbstractThird",
43                  DEFAULT_PATTERN),
44              "19:3: " + getCheckMessage(MSG_ILLEGAL_ABSTRACT_CLASS_NAME, "GeneratorFifth",
45                      DEFAULT_PATTERN),
46          };
47  
48          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
49      }
50  
51      @Test
52      public void testExample2() throws Exception {
53          final String[] expected = {
54              "18:3: " + getCheckMessage(MSG_ILLEGAL_ABSTRACT_CLASS_NAME, "Second", DEFAULT_PATTERN),
55              "21:3: " + getCheckMessage(MSG_ILLEGAL_ABSTRACT_CLASS_NAME, "GeneratorFifth",
56                      DEFAULT_PATTERN),
57          };
58  
59          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
60      }
61  
62      @Test
63      public void testExample3() throws Exception {
64          final String[] expected = {
65              "19:3: " + getCheckMessage(MSG_NO_ABSTRACT_CLASS_MODIFIER, "AbstractThird",
66                  DEFAULT_PATTERN),
67          };
68  
69          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
70      }
71  
72      @Test
73      public void testExample4() throws Exception {
74          final String pattern = "^Generator.+$";
75  
76          final String[] expected = {
77              "17:3: " + getCheckMessage(MSG_ILLEGAL_ABSTRACT_CLASS_NAME, "AbstractFirst", pattern),
78              "18:3: " + getCheckMessage(MSG_ILLEGAL_ABSTRACT_CLASS_NAME, "Second", pattern),
79              "23:3: " + getCheckMessage(MSG_NO_ABSTRACT_CLASS_MODIFIER, "GeneratorSixth",
80                  pattern),
81          };
82  
83          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
84      }
85  
86  }