1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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 @Override
30 protected String getPackageLocation() {
31 return "com/puppycrawl/tools/checkstyle/checks/javadoc/atclauseorder";
32 }
33
34 @Test
35 public void testExample1() throws Exception {
36 final String tagOrder = "[@author, @version, @param, @return, @throws"
37 + ", @exception, @see,"
38 + " @since, @serial, @serialField, @serialData, @deprecated]";
39
40 final String[] expected = {
41 "42: " + getCheckMessage(MSG_KEY, tagOrder),
42 "44: " + getCheckMessage(MSG_KEY, tagOrder),
43 "52: " + getCheckMessage(MSG_KEY, tagOrder),
44 "54: " + getCheckMessage(MSG_KEY, tagOrder),
45 "55: " + getCheckMessage(MSG_KEY, tagOrder),
46 };
47
48 verifyWithInlineConfigParser(getPath("Example1.java"), expected);
49 }
50
51 @Test
52 public void testExample2() throws Exception {
53 final String tagOrder = "[@author, @since, @version, @param, @return"
54 + ", @throws, @exception,"
55 + " @deprecated, @see, @serial, @serialField, @serialData]";
56
57 final String[] expected = {
58 "29: " + getCheckMessage(MSG_KEY, tagOrder),
59 "55: " + getCheckMessage(MSG_KEY, tagOrder),
60 };
61
62 verifyWithInlineConfigParser(getPath("Example2.java"), expected);
63 }
64
65 @Test
66 public void testExample3() throws Exception {
67 final String tagOrder = "[@author, @since, @version, @param, @return"
68 + ", @throws, @exception,"
69 + " @deprecated, @see, @serial, @serialField, @serialData]";
70
71 final String[] expected = {
72 "55: " + getCheckMessage(MSG_KEY, tagOrder),
73 };
74
75 verifyWithInlineConfigParser(getPath("Example3.java"), expected);
76 }
77 }