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.javadoc;
21  
22  import org.junit.jupiter.api.Test;
23  
24  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
25  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
26  
27  public class IllegalBlockTagCheckExamplesTest extends AbstractExamplesModuleTestSupport {
28  
29      @Override
30      public String getPackageLocation() {
31          return "com/puppycrawl/tools/checkstyle/checks/javadoc/illegalblocktag";
32      }
33  
34      @Test
35      public void testExample1() throws Exception {
36          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
37          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
38      }
39  
40      @Test
41      public void testExample2() throws Exception {
42          final String[] expected = {
43              "22:6: " + getCheckMessage(IllegalBlockTagCheck.MSG_ILLEGAL_PATTERN, "todo"),
44              "35:6: " + getCheckMessage(IllegalBlockTagCheck.MSG_ILLEGAL_PATTERN, "todo"),
45          };
46          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
47      }
48  
49      @Test
50      public void testExample3() throws Exception {
51          final String[] expected = {
52              "17:4: " + getCheckMessage(IllegalBlockTagCheck.MSG_ILLEGAL_PATTERN, "since"),
53              "24:6: " + getCheckMessage(IllegalBlockTagCheck.MSG_ILLEGAL_PATTERN, "since"),
54          };
55          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
56      }
57  
58      @Test
59      public void testExample4() throws Exception {
60          final String[] expected = {
61              "20:4: " + getCheckMessage(IllegalBlockTagCheck.MSG_ILLEGAL_PATTERN, "since"),
62          };
63          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
64      }
65  
66  }