|
1 /* |
|
2 * Copyright (c) 2002, 2013, 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 * @build JavadocTester |
|
32 * @build TestOverridenPrivateMethods |
|
33 * @run main TestOverridenPrivateMethods |
|
34 */ |
|
35 |
|
36 public 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 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>" + NL + |
|
44 "<dd><code><a href=\"../pkg1/BaseClass.html#publicMethod"}, |
|
45 |
|
46 //The public method in different package should be overriden |
|
47 {BUG_ID + FS + "pkg2" + FS + "SubClass.html", |
|
48 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>" + NL + |
|
49 "<dd><code><a href=\"../pkg1/BaseClass.html#publicMethod"} |
|
50 }; |
|
51 |
|
52 private static final String[][] NEGATED_TEST = { |
|
53 |
|
54 //The package private method should be overriden since the base and sub class are in the same |
|
55 //package. However, the link should not show up because the package private methods are not documented. |
|
56 {BUG_ID + FS + "pkg1" + FS + "SubClass.html", |
|
57 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>" + NL + |
|
58 "<dd><code><a href=\"../pkg1/BaseClass.html#packagePrivateMethod"}, |
|
59 |
|
60 //The private method in should not be overriden |
|
61 {BUG_ID + FS + "pkg1" + FS + "SubClass.html", |
|
62 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>" + NL + |
|
63 "<dd><code><a href=\"../pkg1/BaseClass.html#privateMethod"}, |
|
64 |
|
65 //The private method in different package should not be overriden |
|
66 {BUG_ID + FS + "pkg2" + FS + "SubClass.html", |
|
67 "<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>" + NL + |
|
68 "<dd><code><a href=\"../pkg1/BaseClass.html#privateMethod"}, |
|
69 |
|
70 //The package private method should not be overriden since the base and sub class are in |
|
71 //different packages. |
|
72 {BUG_ID + FS + "pkg2" + FS + "SubClass.html", |
|
73 "Overrides:</span></dt><dd><code><a href=\"../pkg1/BaseClass.html#packagePrivateMethod"} |
|
74 }; |
|
75 |
|
76 private static final String[] ARGS = |
|
77 new String[] { |
|
78 "-d", BUG_ID, "-sourcepath", SRC_DIR, "pkg1", "pkg2"}; |
|
79 |
|
80 /** |
|
81 * The entry point of the test. |
|
82 * @param args the array of command line arguments. |
|
83 */ |
|
84 public static void main(String[] args) { |
|
85 TestOverridenPrivateMethods tester = new TestOverridenPrivateMethods(); |
|
86 run(tester, ARGS, TEST, NEGATED_TEST); |
|
87 tester.printSummary(); |
|
88 } |
|
89 |
|
90 /** |
|
91 * {@inheritDoc} |
|
92 */ |
|
93 public String getBugId() { |
|
94 return BUG_ID; |
|
95 } |
|
96 |
|
97 /** |
|
98 * {@inheritDoc} |
|
99 */ |
|
100 public String getBugName() { |
|
101 return getClass().getName(); |
|
102 } |
|
103 } |