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.AbstractModuleTestSupport;
28  
29  public class JavadocLinkWellKnownApiCheckTest extends AbstractModuleTestSupport {
30  
31      @Override
32      public String getPackageLocation() {
33          return "com/puppycrawl/tools/checkstyle/checks/javadoc/javadoclinkwellknownapi";
34      }
35  
36      @Test
37      public void testDefault() throws Exception {
38          final String[] expected = {
39              "22:13: " + getCheckMessage(MSG_WELL_KNOWN_API, "String"),
40              "28:13: " + getCheckMessage(MSG_WELL_KNOWN_PACKAGE, "java.lang.String"),
41              "34:13: " + getCheckMessage(MSG_WELL_KNOWN_API, "String"),
42              "46:13: " + getCheckMessage(MSG_WELL_KNOWN_PACKAGE, "java.lang.Class"),
43          };
44          verifyWithInlineConfigParser(
45                  getPath("InputJavadocLinkWellKnownApi.java"), expected);
46      }
47  
48      @Test
49      public void testCustomProperties() throws Exception {
50          final String[] expected = {
51              "24:13: " + getCheckMessage(MSG_WELL_KNOWN_API, "Integer"),
52              "30:13: " + getCheckMessage(MSG_WELL_KNOWN_API, "Object"),
53              "36:13: " + getCheckMessage(MSG_WELL_KNOWN_PACKAGE, "java.util.List"),
54              "42:13: " + getCheckMessage(MSG_WELL_KNOWN_PACKAGE, "java.io.File"),
55          };
56          verifyWithInlineConfigParser(
57                  getPath("InputJavadocLinkWellKnownApiCustom.java"), expected);
58      }
59  
60  }