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.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 WriteTagCheckExamplesTest extends AbstractExamplesModuleTestSupport {
28      @Override
29      protected String getPackageLocation() {
30          return "com/puppycrawl/tools/checkstyle/checks/javadoc/writetag";
31      }
32  
33      @Test
34      public void testExample1() throws Exception {
35          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
36          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
37      }
38  
39      @Test
40      public void testExample2() throws Exception {
41          final String[] expected = {
42              "16: " + getCheckMessage(WriteTagCheck.MSG_MISSING_TAG, "@since"),
43          };
44  
45          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
46      }
47  
48      @Test
49      public void testExample3() throws Exception {
50          final String[] expected = {
51              "19: " + getCheckMessage(WriteTagCheck.MSG_MISSING_TAG, "@since"),
52              "24: " + getCheckMessage(WriteTagCheck.MSG_WRITE_TAG, "@since", ""),
53              "29: " + getCheckMessage(WriteTagCheck.MSG_MISSING_TAG, "@since"),
54          };
55  
56          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
57      }
58  
59      @Test
60      public void testExample4() throws Exception {
61          final String pattern = "[1-9\\.]";
62          final String[] expected = {
63              "26: " + getCheckMessage(WriteTagCheck.MSG_TAG_FORMAT, "@since", pattern),
64              "31: " + getCheckMessage(WriteTagCheck.MSG_MISSING_TAG, "@since"),
65          };
66  
67          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
68      }
69  
70      @Test
71      public void testExample5() throws Exception {
72          final String pattern = "[1-9\\.]";
73          final String[] expected = {
74              "21: " + getCheckMessage(WriteTagCheck.MSG_WRITE_TAG, "@since", "1.2"),
75              "27: " + getCheckMessage(WriteTagCheck.MSG_TAG_FORMAT, "@since", pattern),
76              "32: " + getCheckMessage(WriteTagCheck.MSG_MISSING_TAG, "@since"),
77          };
78  
79          verifyWithInlineConfigParser(getPath("Example5.java"), expected);
80      }
81  }