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.JavadocLinkWellKnownApiCheck.MSG_WELL_KNOWN_API;
23  import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocLinkWellKnownApiCheck.MSG_WELL_KNOWN_PACKAGE;
24  
25  import org.junit.jupiter.api.Test;
26  
27  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
28  
29  public class JavadocLinkWellKnownApiCheckExamplesTest
30          extends AbstractExamplesModuleTestSupport {
31  
32      @Override
33      public String getPackageLocation() {
34          return "com/puppycrawl/tools/checkstyle/checks/javadoc/javadoclinkwellknownapi";
35      }
36  
37      @Test
38      public void testExample1() throws Exception {
39          final String[] expected = {
40              "15:13: " + getCheckMessage(MSG_WELL_KNOWN_API, "String"),
41              "33:13: " + getCheckMessage(MSG_WELL_KNOWN_PACKAGE, "java.lang.String"),
42              "39:13: " + getCheckMessage(MSG_WELL_KNOWN_API, "String"),
43          };
44  
45          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
46      }
47  
48      @Test
49      public void testExample2() throws Exception {
50          final String[] expected = {
51              "17:13: " + getCheckMessage(MSG_WELL_KNOWN_API, "String"),
52              "29:13: " + getCheckMessage(MSG_WELL_KNOWN_PACKAGE, "java.util.List"),
53              "35:13: " + getCheckMessage(MSG_WELL_KNOWN_PACKAGE, "java.lang.String"),
54              "41:13: " + getCheckMessage(MSG_WELL_KNOWN_API, "String"),
55          };
56  
57          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
58      }
59  
60      @Test
61      public void testExample3() throws Exception {
62          final String[] expected = {
63              "18:13: " + getCheckMessage(MSG_WELL_KNOWN_API, "String"),
64              "24:13: " + getCheckMessage(MSG_WELL_KNOWN_API, "Integer"),
65              "36:13: " + getCheckMessage(MSG_WELL_KNOWN_PACKAGE, "java.lang.String"),
66              "42:13: " + getCheckMessage(MSG_WELL_KNOWN_API, "String"),
67          };
68  
69          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
70      }
71  
72  }