1 /*
2  * Copyright (c) 2002, 2018, 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  * @author jamieh
30  * @library ../lib
31  * @modules jdk.javadoc/jdk.javadoc.internal.tool
32  * @build JavadocTester
33  * @run main TestOverriddenPrivateMethodsWithPackageFlag
34  */
35 
36 public class TestOverriddenPrivateMethodsWithPackageFlag extends JavadocTester {
37 
main(String... args)38     public static void main(String... args) throws Exception {
39         TestOverriddenPrivateMethodsWithPackageFlag tester = new TestOverriddenPrivateMethodsWithPackageFlag();
40         tester.runTests();
41     }
42 
43     @Test
test()44     void test() {
45         javadoc("-d", "out",
46                 "-sourcepath", testSrc,
47                 "-package",
48                 "pkg1", "pkg2");
49         checkExit(Exit.OK);
50 
51         // The public method should be overridden
52         checkOutput("pkg1/SubClass.html", true,
53                 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
54                 + "<dd><code><a href=\"BaseClass.html#publicMethod()\">"
55                 + "publicMethod</a></code>&nbsp;in class&nbsp;<code>"
56                 + "<a href=\"BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>");
57 
58         // The public method in different package should be overridden
59         checkOutput("pkg2/SubClass.html", true,
60                 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
61                 + "<dd><code><a href=\"../pkg1/BaseClass.html#publicMethod()\">"
62                 + "publicMethod</a></code>&nbsp;in class&nbsp;<code>"
63                 + "<a href=\"../pkg1/BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>");
64 
65         // The package private method should be overridden since the base and sub class are in the same
66         // package.
67         checkOutput("pkg1/SubClass.html", true,
68                 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
69                 + "<dd><code><a href=\"BaseClass.html#packagePrivateMethod()\">"
70                 + "packagePrivateMethod</a></code>&nbsp;in class&nbsp;<code>"
71                 + "<a href=\"BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>");
72 
73         // The private method in should not be overridden
74         checkOutput("pkg1/SubClass.html", false,
75                 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
76                 + "<dd><code><a href=\"BaseClass.html#privateMethod--\">");
77 
78         // The private method in different package should not be overridden
79         checkOutput("pkg2/SubClass.html", false,
80                 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
81                 + "<dd><code><a href=\"../pkg1/BaseClass.html#privateMethod--\">");
82 
83         // The package private method should not be overridden since the base and sub class are in
84         // different packages.
85         checkOutput("pkg2/SubClass.html", false,
86                 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
87                 + "<dd><code><a href=\"../pkg1/BaseClass.html#packagePrivateMethod--\">");
88     }
89 
90     @Test
test_html4()91     void test_html4() {
92         javadoc("-d", "out-html4",
93                 "-html4",
94                 "-sourcepath", testSrc,
95                 "-package",
96                 "pkg1", "pkg2");
97         checkExit(Exit.OK);
98 
99         // The public method should be overridden
100         checkOutput("pkg1/SubClass.html", true,
101                 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
102                 + "<dd><code><a href=\"BaseClass.html#publicMethod--\">"
103                 + "publicMethod</a></code>&nbsp;in class&nbsp;<code>"
104                 + "<a href=\"BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>");
105 
106         // The public method in different package should be overridden
107         checkOutput("pkg2/SubClass.html", true,
108                 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
109                 + "<dd><code><a href=\"../pkg1/BaseClass.html#publicMethod--\">"
110                 + "publicMethod</a></code>&nbsp;in class&nbsp;<code>"
111                 + "<a href=\"../pkg1/BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>");
112 
113         // The package private method should be overridden since the base and sub class are in the same
114         // package.
115         checkOutput("pkg1/SubClass.html", true,
116                 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
117                 + "<dd><code><a href=\"BaseClass.html#packagePrivateMethod--\">"
118                 + "packagePrivateMethod</a></code>&nbsp;in class&nbsp;<code>"
119                 + "<a href=\"BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>");
120 
121         // The private method in should not be overridden
122         checkOutput("pkg1/SubClass.html", false,
123                 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
124                 + "<dd><code><a href=\"BaseClass.html#privateMethod()\">");
125 
126         // The private method in different package should not be overridden
127         checkOutput("pkg2/SubClass.html", false,
128                 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
129                 + "<dd><code><a href=\"../pkg1/BaseClass.html#privateMethod()\">");
130 
131         // The package private method should not be overridden since the base and sub class are in
132         // different packages.
133         checkOutput("pkg2/SubClass.html", false,
134                 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
135                 + "<dd><code><a href=\"../pkg1/BaseClass.html#packagePrivateMethod()\">");
136     }
137 }
138