TestOverridenPrivateMethods.java revision 232:5240b1120530 
1/*
2 * Copyright 2002 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
20 * CA 95054 USA or visit www.sun.com if you need additional information or
21 * have any questions.
22 */
23
24/*
25 * @test
26 * @bug 4634891
27 * @summary Determine if overriden methods are properly documented when
28 * -protected (default) visibility flag is used.
29 * @author jamieh
30 * @library ../lib/
31 * @build JavadocTester
32 * @build TestOverridenPrivateMethods
33 * @run main TestOverridenPrivateMethods
34 */
35
36public class TestOverridenPrivateMethods extends JavadocTester {
37
38    private static final String BUG_ID = "4634891";
39
40    private static final String[][] TEST = {
41        //The public method should be overriden
42        {BUG_ID + FS + "pkg1" + FS + "SubClass.html",
43         "Overrides:</STRONG></DT><DD><CODE><A HREF=\"../pkg1/BaseClass.html#publicMethod"},
44
45        //The public method in different package should be overriden
46        {BUG_ID + FS + "pkg2" + FS + "SubClass.html",
47         "Overrides:</STRONG></DT><DD><CODE><A HREF=\"../pkg1/BaseClass.html#publicMethod"}
48    };
49
50    private static final String[][] NEGATED_TEST = {
51
52        //The package private method should be overriden since the base and sub class are in the same
53        //package.  However, the link should not show up because the package private methods are not documented.
54        {BUG_ID + FS + "pkg1" + FS + "SubClass.html",
55         "Overrides:</STRONG></DT><DD><CODE><A HREF=\"../pkg1/BaseClass.html#packagePrivateMethod"},
56
57        //The private method in should not be overriden
58        {BUG_ID + FS + "pkg1" + FS + "SubClass.html",
59         "Overrides:</STRONG></DT><DD><CODE><A HREF=\"../pkg1/BaseClass.html#privateMethod"},
60
61        //The private method in different package should not be overriden
62        {BUG_ID + FS + "pkg2" + FS + "SubClass.html",
63         "Overrides:</STRONG></DT><DD><CODE><A HREF=\"../pkg1/BaseClass.html#privateMethod"},
64
65        //The package private method should not be overriden since the base and sub class are in
66        //different packages.
67        {BUG_ID + FS + "pkg2" + FS + "SubClass.html",
68         "Overrides:</STRONG></DT><DD><CODE><A HREF=\"../pkg1/BaseClass.html#packagePrivateMethod"}
69    };
70
71    private static final String[] ARGS =
72        new String[] {
73            "-d", BUG_ID, "-sourcepath", SRC_DIR, "pkg1", "pkg2"};
74
75    /**
76     * The entry point of the test.
77     * @param args the array of command line arguments.
78     */
79    public static void main(String[] args) {
80        TestOverridenPrivateMethods tester = new TestOverridenPrivateMethods();
81        run(tester, ARGS, TEST, NEGATED_TEST);
82        tester.printSummary();
83    }
84
85    /**
86     * {@inheritDoc}
87     */
88    public String getBugId() {
89        return BUG_ID;
90    }
91
92    /**
93     * {@inheritDoc}
94     */
95    public String getBugName() {
96        return getClass().getName();
97    }
98}
99