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 static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.MSG_EXPECTED_TAG;
23  import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMethodCheck.MSG_RETURN_EXPECTED;
24  
25  import org.junit.jupiter.api.Test;
26  
27  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
28  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
29  
30  public class JavadocMethodCheckExamplesTest extends AbstractExamplesModuleTestSupport {
31  
32      @Override
33      public String getPackageLocation() {
34          return "com/puppycrawl/tools/checkstyle/checks/javadoc/javadocmethod";
35      }
36  
37      @Test
38      public void testExample1() throws Exception {
39          final String[] expected = {
40              "16:16: " + getCheckMessage(MSG_EXPECTED_TAG, "@param", "x"),
41              "19: " + getCheckMessage(MSG_RETURN_EXPECTED, "@return"),
42              "19:21: " + getCheckMessage(MSG_EXPECTED_TAG, "@param", "p1"),
43              "29: " + getCheckMessage(MSG_RETURN_EXPECTED, "@return"),
44              "35:15: " + getCheckMessage(MSG_EXPECTED_TAG, "@param", "p1"),
45              "40: " + getCheckMessage(MSG_RETURN_EXPECTED, "@return"),
46          };
47  
48          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
49      }
50  
51      @Test
52      public void testExample2() throws Exception {
53          final String[] expected = {
54              "22: " + getCheckMessage(MSG_RETURN_EXPECTED, "@return"),
55              "43: " + getCheckMessage(MSG_RETURN_EXPECTED, "@return"),
56          };
57  
58          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
59      }
60  
61      @Test
62      public void testExample3() throws Exception {
63          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
64          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
65      }
66  
67      @Test
68      public void testExample4() throws Exception {
69          final String[] expected = {
70              "18:16: " + getCheckMessage(MSG_EXPECTED_TAG, "@param", "x"),
71              "21:21: " + getCheckMessage(MSG_EXPECTED_TAG, "@param", "p1"),
72              "37:15: " + getCheckMessage(MSG_EXPECTED_TAG, "@param", "p1"),
73          };
74  
75          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
76      }
77  
78      @Test
79      public void testExample5() throws Exception {
80          final String[] expected = {
81              "18:16: " + getCheckMessage(MSG_EXPECTED_TAG, "@param", "x"),
82              "21: " + getCheckMessage(MSG_RETURN_EXPECTED, "@return"),
83              "21:21: " + getCheckMessage(MSG_EXPECTED_TAG, "@param", "p1"),
84              "37:15: " + getCheckMessage(MSG_EXPECTED_TAG, "@param", "p1"),
85              "42: " + getCheckMessage(MSG_RETURN_EXPECTED, "@return"),
86          };
87  
88          verifyWithInlineConfigParser(getPath("Example5.java"), expected);
89      }
90  
91      @Test
92      public void testExample6() throws Exception {
93          final String[] expected = {
94              "18:16: " + getCheckMessage(MSG_EXPECTED_TAG, "@param", "x"),
95          };
96  
97          verifyWithInlineConfigParser(getPath("Example6.java"), expected);
98      }
99  
100     @Test
101     public void testExample7() throws Exception {
102         final String[] expected = {
103             "18:16: " + getCheckMessage(MSG_EXPECTED_TAG, "@param", "x"),
104             "21: " + getCheckMessage(MSG_RETURN_EXPECTED, "@return"),
105             "21:21: " + getCheckMessage(MSG_EXPECTED_TAG, "@param", "p1"),
106             "21:32: " + getCheckMessage(MSG_EXPECTED_TAG, "@throws", "IOException"),
107             "31: " + getCheckMessage(MSG_RETURN_EXPECTED, "@return"),
108             "37:15: " + getCheckMessage(MSG_EXPECTED_TAG, "@param", "p1"),
109             "42: " + getCheckMessage(MSG_RETURN_EXPECTED, "@return"),
110         };
111 
112         verifyWithInlineConfigParser(getPath("Example7.java"), expected);
113     }
114 
115     @Test
116     public void testExample8() throws Exception {
117         final String[] expected = {
118             "18:16: " + getCheckMessage(MSG_EXPECTED_TAG, "@param", "x"),
119             "21: " + getCheckMessage(MSG_RETURN_EXPECTED, "@return"),
120             "21:21: " + getCheckMessage(MSG_EXPECTED_TAG, "@param", "p1"),
121             "31: " + getCheckMessage(MSG_RETURN_EXPECTED, "@return"),
122             "37:15: " + getCheckMessage(MSG_EXPECTED_TAG, "@param", "p1"),
123         };
124         verifyWithInlineConfigParser(getPath("Example8.java"), expected);
125     }
126 
127 }