TestOverridenPrivateMethods.java revision 3233:b5d08bc0d224 
1/*
2 * Copyright (c) 2002, 2015, 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 8026567
27 * @summary Determine if overriden methods are properly documented when
28 * -protected (default) visibility flag is used.
29 * @author jamieh
30 * @library ../lib
31 * @modules jdk.javadoc
32 * @build JavadocTester
33 * @run main TestOverridenPrivateMethods
34 */
35
36public class TestOverridenPrivateMethods extends JavadocTester {
37
38    public static void main(String... args) throws Exception {
39        TestOverridenPrivateMethods tester = new TestOverridenPrivateMethods();
40        tester.runTests();
41    }
42
43    @Test
44    void test() {
45        javadoc("-d", "out",
46                "-sourcepath", testSrc,
47                "pkg1", "pkg2");
48        checkExit(Exit.OK);
49
50        // The public method should be overridden
51        checkOutput("pkg1/SubClass.html", true,
52                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
53                + "<dd><code><a href=\"../pkg1/BaseClass.html#publicMethod");
54
55        // The public method in different package should be overridden
56        checkOutput("pkg2/SubClass.html", true,
57                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
58                + "<dd><code><a href=\"../pkg1/BaseClass.html#publicMethod");
59
60        checkOutput("pkg1/SubClass.html", false,
61                //The package private method should be overridden since the base and sub class are in the same
62                //package.  However, the link should not show up because the package private methods are not documented.
63                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
64                + "<dd><code><a href=\"../pkg1/BaseClass.html#packagePrivateMethod",
65                //The private method in should not be overridden
66                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
67                + "<dd><code><a href=\"../pkg1/BaseClass.html#privateMethod");
68
69        checkOutput("pkg2/SubClass.html", false,
70                //The private method in different package should not be overridden
71                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
72                + "<dd><code><a href=\"../pkg1/BaseClass.html#privateMethod",
73                //The package private method should not be overridden since the base and sub class are in
74                //different packages.
75                "Overrides:</span></dt><dd><code><a href=\"../pkg1/BaseClass.html#packagePrivateMethod");
76    }
77}
78