File: TestOverriddenPrivateMethodsWithPackageFlag.java

package info (click to toggle)
openjdk-11 11.0.29~4ea-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 780,672 kB
  • sloc: java: 5,208,618; xml: 1,192,267; cpp: 1,138,375; ansic: 461,923; javascript: 162,416; sh: 16,738; objc: 13,729; python: 4,757; asm: 3,570; makefile: 2,970; perl: 357; awk: 351; sed: 172; jsp: 24; csh: 3
file content (137 lines) | stat: -rw-r--r-- 6,759 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/*
 * Copyright (c) 2002, 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

/*
 * @test
 * @bug 4634891 8025633 8026567 8182765
 * @summary Determine if overridden methods are properly documented when
 * -protected (default) visibility flag is used.
 * @author jamieh
 * @library ../lib
 * @modules jdk.javadoc/jdk.javadoc.internal.tool
 * @build JavadocTester
 * @run main TestOverriddenPrivateMethodsWithPackageFlag
 */

public class TestOverriddenPrivateMethodsWithPackageFlag extends JavadocTester {

    public static void main(String... args) throws Exception {
        TestOverriddenPrivateMethodsWithPackageFlag tester = new TestOverriddenPrivateMethodsWithPackageFlag();
        tester.runTests();
    }

    @Test
    void test() {
        javadoc("-d", "out",
                "-sourcepath", testSrc,
                "-package",
                "pkg1", "pkg2");
        checkExit(Exit.OK);

        // The public method should be overridden
        checkOutput("pkg1/SubClass.html", true,
                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
                + "<dd><code><a href=\"BaseClass.html#publicMethod()\">"
                + "publicMethod</a></code>&nbsp;in class&nbsp;<code>"
                + "<a href=\"BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>");

        // The public method in different package should be overridden
        checkOutput("pkg2/SubClass.html", true,
                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
                + "<dd><code><a href=\"../pkg1/BaseClass.html#publicMethod()\">"
                + "publicMethod</a></code>&nbsp;in class&nbsp;<code>"
                + "<a href=\"../pkg1/BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>");

        // The package private method should be overridden since the base and sub class are in the same
        // package.
        checkOutput("pkg1/SubClass.html", true,
                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
                + "<dd><code><a href=\"BaseClass.html#packagePrivateMethod()\">"
                + "packagePrivateMethod</a></code>&nbsp;in class&nbsp;<code>"
                + "<a href=\"BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>");

        // The private method in should not be overridden
        checkOutput("pkg1/SubClass.html", false,
                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
                + "<dd><code><a href=\"BaseClass.html#privateMethod--\">");

        // The private method in different package should not be overridden
        checkOutput("pkg2/SubClass.html", false,
                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
                + "<dd><code><a href=\"../pkg1/BaseClass.html#privateMethod--\">");

        // The package private method should not be overridden since the base and sub class are in
        // different packages.
        checkOutput("pkg2/SubClass.html", false,
                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
                + "<dd><code><a href=\"../pkg1/BaseClass.html#packagePrivateMethod--\">");
    }

    @Test
    void test_html4() {
        javadoc("-d", "out-html4",
                "-html4",
                "-sourcepath", testSrc,
                "-package",
                "pkg1", "pkg2");
        checkExit(Exit.OK);

        // The public method should be overridden
        checkOutput("pkg1/SubClass.html", true,
                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
                + "<dd><code><a href=\"BaseClass.html#publicMethod--\">"
                + "publicMethod</a></code>&nbsp;in class&nbsp;<code>"
                + "<a href=\"BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>");

        // The public method in different package should be overridden
        checkOutput("pkg2/SubClass.html", true,
                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
                + "<dd><code><a href=\"../pkg1/BaseClass.html#publicMethod--\">"
                + "publicMethod</a></code>&nbsp;in class&nbsp;<code>"
                + "<a href=\"../pkg1/BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>");

        // The package private method should be overridden since the base and sub class are in the same
        // package.
        checkOutput("pkg1/SubClass.html", true,
                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
                + "<dd><code><a href=\"BaseClass.html#packagePrivateMethod--\">"
                + "packagePrivateMethod</a></code>&nbsp;in class&nbsp;<code>"
                + "<a href=\"BaseClass.html\" title=\"class in pkg1\">BaseClass</a></code></dd>");

        // The private method in should not be overridden
        checkOutput("pkg1/SubClass.html", false,
                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
                + "<dd><code><a href=\"BaseClass.html#privateMethod()\">");

        // The private method in different package should not be overridden
        checkOutput("pkg2/SubClass.html", false,
                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
                + "<dd><code><a href=\"../pkg1/BaseClass.html#privateMethod()\">");

        // The package private method should not be overridden since the base and sub class are in
        // different packages.
        checkOutput("pkg2/SubClass.html", false,
                "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
                + "<dd><code><a href=\"../pkg1/BaseClass.html#packagePrivateMethod()\">");
    }
}