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.AbstractModuleTestSupport;
25  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
26  
27  public class JavadocThrowsOrderCheckTest extends AbstractModuleTestSupport {
28  
29      private static final String MSG_KEY = JavadocThrowsOrderCheck.MSG_KEY;
30  
31      @Override
32      public String getPackageLocation() {
33          return "com/puppycrawl/tools/checkstyle/checks/javadoc/javadocthrowsorder";
34      }
35  
36      @Test
37      public void testCorrect() throws Exception {
38          verifyWithInlineConfigParser(
39                  getPath("InputJavadocThrowsOrderCorrect.java"),
40                  CommonUtil.EMPTY_STRING_ARRAY);
41      }
42  
43      @Test
44      public void testIncorrect() throws Exception {
45          final String[] expected = {
46              "19:8: " + getCheckMessage(MSG_KEY, "throws",
47                      "IllegalArgumentException", "NullPointerException"),
48              "29:8: " + getCheckMessage(MSG_KEY, "exception", "IOException",
49                      "SecurityException"),
50              "39:8: " + getCheckMessage(MSG_KEY, "throws",
51                      "IllegalArgumentException", "NullPointerException"),
52              "51:8: " + getCheckMessage(MSG_KEY, "throws", "AlphaException",
53                      "ZebraException"),
54              "52:8: " + getCheckMessage(MSG_KEY, "throws", "BetaException",
55                      "ZebraException"),
56          };
57  
58          verifyWithInlineConfigParser(
59                  getPath("InputJavadocThrowsOrderIncorrect.java"), expected);
60      }
61  
62  }