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.AtclauseOrderCheck.MSG_KEY;
23  
24  import org.junit.jupiter.api.Test;
25  
26  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
27  
28  public class AtclauseOrderCheckExamplesTest extends AbstractExamplesModuleTestSupport {
29  
30      @Override
31      public String getPackageLocation() {
32          return "com/puppycrawl/tools/checkstyle/checks/javadoc/atclauseorder";
33      }
34  
35      @Test
36      public void testExample1() throws Exception {
37          final String tagOrder = "[@author, @version, @param, @return"
38              + ", @throws, @exception,"
39              + " @see, @since, @serial, @serialField, @serialData, @deprecated]";
40  
41          final String[] expected = {
42              "48: " + getCheckMessage(MSG_KEY, tagOrder),
43          };
44  
45          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
46      }
47  
48      @Test
49      public void testExample2() throws Exception {
50          final String tagOrder = "[@author, @since, @version, @param, @return"
51              + ", @throws, @exception,"
52              + " @deprecated, @see, @serial, @serialField, @serialData]";
53  
54          final String[] expected = {
55              "29: " + getCheckMessage(MSG_KEY, tagOrder),
56              "44: " + getCheckMessage(MSG_KEY, tagOrder),
57              "45: " + getCheckMessage(MSG_KEY, tagOrder),
58              "52: " + getCheckMessage(MSG_KEY, tagOrder),
59          };
60  
61          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
62      }
63  
64      @Test
65      public void testExample3() throws Exception {
66          final String tagOrder = "[@author, @since, @version, @param, @return"
67              + ", @throws, @exception,"
68              + " @deprecated, @see, @serial, @serialField, @serialData]";
69  
70          final String[] expected = {
71              "44: " + getCheckMessage(MSG_KEY, tagOrder),
72              "45: " + getCheckMessage(MSG_KEY, tagOrder),
73          };
74  
75          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
76      }
77  
78      @Test
79      public void testUseCase1() throws Exception {
80          final String tagOrder = "[@version, @author, @param, @return"
81              + ", @throws, @exception,"
82              + " @see, @since, @serial, @serialField, @serialData]";
83  
84          final String[] expected = {
85              "23: " + getCheckMessage(MSG_KEY, tagOrder),
86          };
87  
88          verifyWithInlineConfigParser(getPath("UseCase1.java"), expected);
89      }
90  
91  }