1 /*
2  * Copyright (c) 2002, 2020, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.
8  *
9  * This code is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12  * version 2 for more details (a copy is included in the LICENSE file that
13  * accompanied this code).
14  *
15  * You should have received a copy of the GNU General Public License version
16  * 2 along with this work; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18  *
19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20  * or visit www.oracle.com if you need additional information or have any
21  * questions.
22  */
23 
24 /*
25  * @test
26  * @bug 4634891 8025633 8026567 8182765
27  * @summary Determine if overridden methods are properly documented when
28  * -protected (default) visibility flag is used.
29  * @library ../../lib
30  * @modules jdk.javadoc/jdk.javadoc.internal.tool
31  * @build javadoc.tester.*
32  * @run main TestOverriddenPrivateMethodsWithPackageFlag
33  */
34 
35 import javadoc.tester.JavadocTester;
36 
37 public class TestOverriddenPrivateMethodsWithPackageFlag extends JavadocTester {
38 
main(String... args)39     public static void main(String... args) throws Exception {
40         TestOverriddenPrivateMethodsWithPackageFlag tester = new TestOverriddenPrivateMethodsWithPackageFlag();
41         tester.runTests();
42     }
43 
44     @Test
test()45     public void test() {
46         javadoc("-d", "out",
47                 "-sourcepath", testSrc,
48                 "-package",
49                 "pkg1", "pkg2");
50         checkExit(Exit.OK);
51 
52         // The public method should be overridden
53         checkOutput("pkg1/SubClass.html", true,
54                 """
55                     <dt>Overrides:</dt>
56                     <dd><code><a href="BaseClass.html#publicMethod()">publicMethod</a></code>&nbsp;i\
57                     n class&nbsp;<code><a href="BaseClass.html" title="class in pkg1">BaseClass</a><\
58                     /code></dd>""");
59 
60         // The public method in different package should be overridden
61         checkOutput("pkg2/SubClass.html", true,
62                 """
63                     <dt>Overrides:</dt>
64                     <dd><code><a href="../pkg1/BaseClass.html#publicMethod()">publicMethod</a></code\
65                     >&nbsp;in class&nbsp;<code><a href="../pkg1/BaseClass.html" title="class in pkg1\
66                     ">BaseClass</a></code></dd>""");
67 
68         // The package private method should be overridden since the base and sub class are in the same
69         // package.
70         checkOutput("pkg1/SubClass.html", true,
71                 """
72                     <dt>Overrides:</dt>
73                     <dd><code><a href="BaseClass.html#packagePrivateMethod()">packagePrivateMethod</\
74                     a></code>&nbsp;in class&nbsp;<code><a href="BaseClass.html" title="class in pkg1\
75                     ">BaseClass</a></code></dd>""");
76 
77         // The private method in should not be overridden
78         checkOutput("pkg1/SubClass.html", false,
79                 """
80                     <dt>Overrides:</dt>
81                     <dd><code><a href="BaseClass.html#privateMethod--">""");
82 
83         // The private method in different package should not be overridden
84         checkOutput("pkg2/SubClass.html", false,
85                 """
86                     <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
87                     <dd><code><a href="../pkg1/BaseClass.html#privateMethod--">""");
88 
89         // The package private method should not be overridden since the base and sub class are in
90         // different packages.
91         checkOutput("pkg2/SubClass.html", false,
92                 """
93                     <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
94                     <dd><code><a href="../pkg1/BaseClass.html#packagePrivateMethod--">""");
95     }
96 }
97