Skip to content

Commit 35076af

Browse files
author
Pavel Rappo
committedFeb 23, 2022
8281376: Consider polymorphic methods when looking for overrides
Reviewed-by: hannesw
1 parent 340a35d commit 35076af

File tree

5 files changed

+226
-5
lines changed

5 files changed

+226
-5
lines changed
 

‎src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/WorkArounds.java

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2015, 2021, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2015, 2022, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -221,8 +221,7 @@ public TypeMirror overriddenType(ExecutableElement method) {
221221
if (sym.overrides(sym2, origin, javacTypes, true)) {
222222
// Ignore those methods that may be a simple override
223223
// and allow the real API method to be found.
224-
if (sym2.type.hasTag(TypeTag.METHOD) &&
225-
utils.isSimpleOverride((MethodSymbol)sym2)) {
224+
if (utils.isSimpleOverride((MethodSymbol)sym2)) {
226225
continue;
227226
}
228227
return t;

‎test/langtools/jdk/javadoc/doclet/testOverriddenMethods/TestOverrideMethods.java

+91-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright (c) 2017, 2021, Oracle and/or its affiliates. All rights reserved.
2+
* Copyright (c) 2017, 2022, Oracle and/or its affiliates. All rights reserved.
33
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
44
*
55
* This code is free software; you can redistribute it and/or modify it
@@ -23,7 +23,7 @@
2323

2424
/*
2525
* @test
26-
* @bug 8157000 8192850 8182765 8223607 8261976
26+
* @bug 8157000 8192850 8182765 8223607 8261976 8281376
2727
* @summary test the behavior of --override-methods option
2828
* @library ../../lib
2929
* @modules jdk.javadoc/jdk.javadoc.internal.tool
@@ -569,4 +569,93 @@ n interface in pkg7">@A</a> java.lang.CharSequence&gt;&nbsp;p1,
569569
<dd>something</dd>
570570
</dl>""");
571571
}
572+
573+
@Test
574+
public void testPolymorphicDetail() {
575+
javadoc("-d", "out-polymorphic-detail",
576+
"-sourcepath", testSrc,
577+
"--override-methods=detail",
578+
"pkg8");
579+
580+
checkExit(Exit.OK);
581+
582+
checkOutput("pkg8/C.html", true,
583+
"""
584+
<dt>Overrides:</dt>
585+
<dd><code><a href="P.html#m1()">m1</a></code>&nbsp;in class&nbsp;\
586+
<code><a href="P.html" title="class in pkg8">P</a></code></dd>""");
587+
588+
checkOutput("pkg8/C.html", true,
589+
"""
590+
<dt>Overrides:</dt>
591+
<dd><code><a href="P.html#m2()">m2</a></code>&nbsp;in class&nbsp;\
592+
<code><a href="P.html" title="class in pkg8">P</a></code></dd>""");
593+
594+
checkOutput("pkg8/C.html", true,
595+
"""
596+
<dt>Overrides:</dt>
597+
<dd><code><a href="P.html#m3()">m3</a></code>&nbsp;in class&nbsp;\
598+
<code><a href="P.html" title="class in pkg8">P</a></code></dd>""");
599+
}
600+
601+
@Test // results should be the same as that of "detail"
602+
public void testPolymorphicDefault() {
603+
javadoc("-d", "out-polymorphic-default",
604+
"-sourcepath", testSrc,
605+
"pkg8");
606+
607+
checkExit(Exit.OK);
608+
609+
checkOutput("pkg8/C.html", true,
610+
"""
611+
<dt>Overrides:</dt>
612+
<dd><code><a href="P.html#m1()">m1</a></code>&nbsp;in class&nbsp;\
613+
<code><a href="P.html" title="class in pkg8">P</a></code></dd>""");
614+
615+
checkOutput("pkg8/C.html", true,
616+
"""
617+
<dt>Overrides:</dt>
618+
<dd><code><a href="P.html#m2()">m2</a></code>&nbsp;in class&nbsp;\
619+
<code><a href="P.html" title="class in pkg8">P</a></code></dd>""");
620+
621+
checkOutput("pkg8/C.html", true,
622+
"""
623+
<dt>Overrides:</dt>
624+
<dd><code><a href="P.html#m3()">m3</a></code>&nbsp;in class&nbsp;\
625+
<code><a href="P.html" title="class in pkg8">P</a></code></dd>""");
626+
}
627+
628+
@Test
629+
public void testPolymorphicSummary() {
630+
javadoc("-d", "out-polymorphic-summary",
631+
"-sourcepath", testSrc,
632+
"--override-methods=summary",
633+
"pkg8");
634+
635+
checkExit(Exit.OK);
636+
637+
checkOutput("pkg8/C.html", true,
638+
"""
639+
<dt>Overrides:</dt>
640+
<dd><code><a href="GP.html#m1()">m1</a></code>&nbsp;in class&nbsp;\
641+
<code><a href="GP.html" title="class in pkg8">GP</a></code></dd>""");
642+
643+
checkOutput("pkg8/C.html", true,
644+
"""
645+
<dt>Overrides:</dt>
646+
<dd><code><a href="GP.html#m2()">m2</a></code>&nbsp;in class&nbsp;\
647+
<code><a href="GP.html" title="class in pkg8">GP</a></code></dd>""");
648+
649+
checkOutput("pkg8/C.html", true,
650+
"""
651+
<dt>Overrides:</dt>
652+
<dd><code><a href="GP.html#m3()">m3</a></code>&nbsp;in class&nbsp;\
653+
<code><a href="GP.html" title="class in pkg8">GP</a></code></dd>""");
654+
655+
checkOutput("pkg8/C.html", false,
656+
"""
657+
<dt>Overrides:</dt>
658+
<dd><code><a href="GP.html#m1()">m1</a></code>&nbsp;in class&nbsp;\
659+
<code><a href="P.html" title="class in pkg8">P</a></code></dd>""");
660+
}
572661
}

‎test/langtools/jdk/javadoc/doclet/testOverriddenMethods/pkg8/C.java

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
/*
2+
* Copyright (c) 2022, 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+
package pkg8;
25+
26+
public class C extends P {
27+
28+
/**
29+
* Child m1().
30+
*
31+
* @param <T> Child m1's type
32+
*/
33+
@Override
34+
public <T> void m1() {}
35+
36+
/**
37+
* Child m2().
38+
*/
39+
@Override
40+
public void m2() {}
41+
42+
/**
43+
* Child m3().
44+
*/
45+
@Override
46+
public void m3() {}
47+
}

‎test/langtools/jdk/javadoc/doclet/testOverriddenMethods/pkg8/GP.java

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
/*
2+
* Copyright (c) 2022, 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+
package pkg8;
25+
26+
public class GP {
27+
28+
/**
29+
* Grandparent m1().
30+
*
31+
* @param <T> Grandparent m1's type
32+
*/
33+
public <T> void m1() {}
34+
35+
/**
36+
* Grandparent m2().
37+
*
38+
* @param <T> Grandparent m2's type
39+
*/
40+
public <T> void m2() {}
41+
42+
/**
43+
* Grandparent m3().
44+
*
45+
* @param <T> Grandparent m3's type
46+
*/
47+
public <T> void m3() {}
48+
}

‎test/langtools/jdk/javadoc/doclet/testOverriddenMethods/pkg8/P.java

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
/*
2+
* Copyright (c) 2022, 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+
package pkg8;
25+
26+
public class P extends GP {
27+
28+
// note that while m1() and m2() are parameterized, m3() is not
29+
30+
@Override
31+
public <T> void m1() {}
32+
33+
@Override
34+
public <T> void m2() {}
35+
36+
@Override
37+
public void m3() {}
38+
}

0 commit comments

Comments
 (0)
Please sign in to comment.