View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2025 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.coding;
21  
22  import org.junit.jupiter.api.Test;
23  
24  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
25  
26  public class IllegalTypeCheckExamplesTest extends AbstractExamplesModuleTestSupport {
27      @Override
28      protected String getPackageLocation() {
29          return "com/puppycrawl/tools/checkstyle/checks/coding/illegaltype";
30      }
31  
32      @Test
33      public void testExample1() throws Exception {
34          final String[] expected = {
35              "16:31: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "TreeSet"),
36              "18:21: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "java.util.HashSet"),
37              "20:5: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "LinkedHashMap"),
38              "22:5: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "TreeMap"),
39              "25:5: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "java.util.TreeSet"),
40              "28:21: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "java.util.HashSet"),
41              "30:10: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "HashMap"),
42              "34:11: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "HashMap"),
43              "38:13: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "HashMap"),
44          };
45  
46          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
47      }
48  
49      @Test
50      public void testExample2() throws Exception {
51          final String[] expected = {
52              "20:21: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "java.util.HashSet"),
53              "30:21: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "java.util.HashSet"),
54              "32:10: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "HashMap"),
55              "36:11: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "HashMap"),
56              "40:13: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "HashMap"),
57          };
58  
59          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
60      }
61  
62      @Test
63      public void testExample3() throws Exception {
64          final String[] expected = {
65              "17:31: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "TreeSet"),
66              "19:21: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "java.util.HashSet"),
67              "21:5: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "LinkedHashMap"),
68              "23:5: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "TreeMap"),
69              "26:5: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "java.util.TreeSet"),
70              "29:21: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "java.util.HashSet"),
71              "39:13: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "HashMap"),
72          };
73  
74          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
75      }
76  
77      @Test
78      public void testExample4() throws Exception {
79          final String[] expected = {
80              "18:31: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "TreeSet"),
81              "20:21: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "java.util.HashSet"),
82              "22:5: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "LinkedHashMap"),
83              "24:5: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "TreeMap"),
84              "27:5: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "java.util.TreeSet"),
85              "30:21: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "java.util.HashSet"),
86              "32:10: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "HashMap"),
87              "36:11: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "HashMap"),
88              "40:13: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "HashMap"),
89              "56:19: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "Gitter"),
90          };
91  
92          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
93      }
94  
95      @Test
96      public void testExample5() throws Exception {
97          final String[] expected = {
98              "18:31: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "TreeSet"),
99              "20:21: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "java.util.HashSet"),
100             "30:21: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "java.util.HashSet"),
101             "32:10: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "HashMap"),
102             "40:13: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "HashMap"),
103         };
104 
105         verifyWithInlineConfigParser(getPath("Example5.java"), expected);
106     }
107 
108     @Test
109     public void testExample6() throws Exception {
110         final String[] expected = {
111             "42:21: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "Boolean"),
112             "50:25: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "Boolean"),
113             "50:56: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "Boolean"),
114             "61:28: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "Foo"),
115             "61:39: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "Boolean"),
116             "67:18: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "Foo"),
117             "67:38: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "Boolean"),
118         };
119 
120         verifyWithInlineConfigParser(getPath("Example6.java"), expected);
121     }
122 
123     @Test
124     public void testExample9() throws Exception {
125         final String[] expected = {
126             "20:31: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "TreeSet"),
127             "22:21: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "java.util.HashSet"),
128             "24:5: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "LinkedHashMap"),
129             "26:5: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "TreeMap"),
130             "29:5: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "java.util.TreeSet"),
131             "32:21: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "java.util.HashSet"),
132             "34:10: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "HashMap"),
133             "38:11: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "HashMap"),
134             "42:13: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "HashMap"),
135             "77:10: " + getCheckMessage(IllegalTypeCheck.MSG_KEY, "AbstractSet"),
136         };
137 
138         verifyWithInlineConfigParser(getPath("Example9.java"), expected);
139     }
140 }