From 61a00c0b93fb676a18b405bfad9f0038330f37ef Mon Sep 17 00:00:00 2001 From: Pavel Rappo Date: Tue, 19 Nov 2024 16:04:47 +0000 Subject: [PATCH 1/4] Initial commit --- .../javax/lang/model/util/Elements.java | 10 +++ .../model/util/elements/overrides/S.java | 27 ++++++++ .../model/util/elements/overrides/T1.java | 27 ++++++++ .../model/util/elements/overrides/T2.java | 27 ++++++++ .../model/util/elements/overrides/T3.java | 27 ++++++++ .../elements/overrides/TestOverrides.java | 69 +++++++++++++++++++ 6 files changed, 187 insertions(+) create mode 100644 test/langtools/tools/javac/processing/model/util/elements/overrides/S.java create mode 100644 test/langtools/tools/javac/processing/model/util/elements/overrides/T1.java create mode 100644 test/langtools/tools/javac/processing/model/util/elements/overrides/T2.java create mode 100644 test/langtools/tools/javac/processing/model/util/elements/overrides/T3.java create mode 100644 test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java diff --git a/src/java.compiler/share/classes/javax/lang/model/util/Elements.java b/src/java.compiler/share/classes/javax/lang/model/util/Elements.java index 7f0b493572e0d..31658a92398bc 100644 --- a/src/java.compiler/share/classes/javax/lang/model/util/Elements.java +++ b/src/java.compiler/share/classes/javax/lang/model/util/Elements.java @@ -778,6 +778,16 @@ default TypeElement getOutermostTypeElement(Element e) { * elements.getTypeElement("I")); * } * + * @apiNote The notion of overriding, by itself, does not involve the + * method's return type, listed exceptions, or, to some extent, access + * modifiers. These are additional requirements checked by the compiler + * (see {@jls 8.4.8.3}). + * + * If the source being reflected upon has not been sufficiently compiled + * — such as when processing annotations — the additional + * requirements might not be checked, potentially causing this method + * to return a false positive. + * * @param overrider the first method, possible overrider * @param overridden the second method, possibly being overridden * @param type the class or interface of which the first method is a member diff --git a/test/langtools/tools/javac/processing/model/util/elements/overrides/S.java b/test/langtools/tools/javac/processing/model/util/elements/overrides/S.java new file mode 100644 index 0000000000000..e7ab532482237 --- /dev/null +++ b/test/langtools/tools/javac/processing/model/util/elements/overrides/S.java @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2023, 2024, 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. + */ + +public class S { + + public void m() { } +} diff --git a/test/langtools/tools/javac/processing/model/util/elements/overrides/T1.java b/test/langtools/tools/javac/processing/model/util/elements/overrides/T1.java new file mode 100644 index 0000000000000..1490211d48844 --- /dev/null +++ b/test/langtools/tools/javac/processing/model/util/elements/overrides/T1.java @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2023, 2024, 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. + */ + +public class T1 extends S { + + protected void m() { } +} diff --git a/test/langtools/tools/javac/processing/model/util/elements/overrides/T2.java b/test/langtools/tools/javac/processing/model/util/elements/overrides/T2.java new file mode 100644 index 0000000000000..deb60cbd023a8 --- /dev/null +++ b/test/langtools/tools/javac/processing/model/util/elements/overrides/T2.java @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2023, 2024, 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. + */ + +public class T2 extends S { + + public int m() { return 0; } +} diff --git a/test/langtools/tools/javac/processing/model/util/elements/overrides/T3.java b/test/langtools/tools/javac/processing/model/util/elements/overrides/T3.java new file mode 100644 index 0000000000000..99f74093a15f1 --- /dev/null +++ b/test/langtools/tools/javac/processing/model/util/elements/overrides/T3.java @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2023, 2024, 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. + */ + +public class T3 extends S { + + public void m() throws Exception { } +} diff --git a/test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java b/test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java new file mode 100644 index 0000000000000..9d80fafc1dd05 --- /dev/null +++ b/test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java @@ -0,0 +1,69 @@ +/* + * Copyright (c) 2023, 2024, 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 8174840 + * @summary Test Elements.isAutomaticModule + * @library /tools/javac/lib + * @build JavacTestingAbstractProcessor TestOverrides + * @compile -processor TestOverrides -proc:only S.java T1.java T2.java T3.java + */ + +import java.util.Set; +import javax.annotation.processing.RoundEnvironment; +import javax.lang.model.element.ExecutableElement; +import javax.lang.model.element.TypeElement; + +import static javax.lang.model.element.ElementKind.METHOD; + +/* + * This test models a few cases where Elements.overrides produces "false + * positives" which warrant @implNote. + */ +public class TestOverrides extends JavacTestingAbstractProcessor { + + @Override + public boolean process(Set annotations, RoundEnvironment round) { + if (!round.processingOver()) { + var sm = mIn(elements.getTypeElement("S")); + for (var subtypeName : new String[]{"T1", "T2", "T3"}) { + var t = elements.getTypeElement(subtypeName); + var tm = mIn(t); + if (!elements.overrides(tm, sm, t)) + messager.printError(String.format( + "%s does not override %s from %s", tm, sm, t.getQualifiedName())); + } + } + return true; + } + + private ExecutableElement mIn(TypeElement t) { + return t.getEnclosedElements().stream() + .filter(e -> e.getKind() == METHOD) + .filter(e -> e.getSimpleName().toString().equals("m")) + .map(e -> (ExecutableElement) e) + .findAny() + .get(); + } +} From a4f0b53ff28898f440476fe9b46bc170cce5df2f Mon Sep 17 00:00:00 2001 From: Pavel Rappo Date: Tue, 19 Nov 2024 16:10:18 +0000 Subject: [PATCH 2/4] Fix copy-paste issues --- .../model/util/elements/overrides/TestOverrides.java | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java b/test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java index 9d80fafc1dd05..8a25994672ee0 100644 --- a/test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java +++ b/test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java @@ -24,7 +24,6 @@ /* * @test * @bug 8174840 - * @summary Test Elements.isAutomaticModule * @library /tools/javac/lib * @build JavacTestingAbstractProcessor TestOverrides * @compile -processor TestOverrides -proc:only S.java T1.java T2.java T3.java @@ -38,8 +37,8 @@ import static javax.lang.model.element.ElementKind.METHOD; /* - * This test models a few cases where Elements.overrides produces "false - * positives" which warrant @implNote. + * This test models a few cases where Elements.overrides produces a false + * positive which warrants @apiNote. */ public class TestOverrides extends JavacTestingAbstractProcessor { From a9a4309b80306c556dce3151d94ced1c5d5dbda4 Mon Sep 17 00:00:00 2001 From: Pavel Rappo Date: Wed, 20 Nov 2024 12:47:40 +0000 Subject: [PATCH 3/4] Respond to feedback - Reduce the number of files - Rephrase apiNote --- .../javax/lang/model/util/Elements.java | 10 +++---- .../model/util/elements/overrides/S.java | 17 +++++++++++- .../model/util/elements/overrides/T1.java | 27 ------------------- .../model/util/elements/overrides/T2.java | 27 ------------------- .../model/util/elements/overrides/T3.java | 27 ------------------- .../elements/overrides/TestOverrides.java | 2 +- 6 files changed, 20 insertions(+), 90 deletions(-) delete mode 100644 test/langtools/tools/javac/processing/model/util/elements/overrides/T1.java delete mode 100644 test/langtools/tools/javac/processing/model/util/elements/overrides/T2.java delete mode 100644 test/langtools/tools/javac/processing/model/util/elements/overrides/T3.java diff --git a/src/java.compiler/share/classes/javax/lang/model/util/Elements.java b/src/java.compiler/share/classes/javax/lang/model/util/Elements.java index 31658a92398bc..35da7563b12b0 100644 --- a/src/java.compiler/share/classes/javax/lang/model/util/Elements.java +++ b/src/java.compiler/share/classes/javax/lang/model/util/Elements.java @@ -780,13 +780,9 @@ default TypeElement getOutermostTypeElement(Element e) { * * @apiNote The notion of overriding, by itself, does not involve the * method's return type, listed exceptions, or, to some extent, access - * modifiers. These are additional requirements checked by the compiler - * (see {@jls 8.4.8.3}). - * - * If the source being reflected upon has not been sufficiently compiled - * — such as when processing annotations — the additional - * requirements might not be checked, potentially causing this method - * to return a false positive. + * modifiers. These are additional requirements checked by the compiler; + * see JLS {@jls 8.4.8.3} for details. An implementation may choose not + * to check the additional requirements under some conditions. * * @param overrider the first method, possible overrider * @param overridden the second method, possibly being overridden diff --git a/test/langtools/tools/javac/processing/model/util/elements/overrides/S.java b/test/langtools/tools/javac/processing/model/util/elements/overrides/S.java index e7ab532482237..b98c27f8731e7 100644 --- a/test/langtools/tools/javac/processing/model/util/elements/overrides/S.java +++ b/test/langtools/tools/javac/processing/model/util/elements/overrides/S.java @@ -21,7 +21,22 @@ * questions. */ -public class S { +class S { public void m() { } } + +class T1 extends S { + + protected void m() { } +} + +class T2 extends S { + + public int m() { return 0; } +} + +class T3 extends S { + + public void m() throws Exception { } +} diff --git a/test/langtools/tools/javac/processing/model/util/elements/overrides/T1.java b/test/langtools/tools/javac/processing/model/util/elements/overrides/T1.java deleted file mode 100644 index 1490211d48844..0000000000000 --- a/test/langtools/tools/javac/processing/model/util/elements/overrides/T1.java +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Copyright (c) 2023, 2024, 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. - */ - -public class T1 extends S { - - protected void m() { } -} diff --git a/test/langtools/tools/javac/processing/model/util/elements/overrides/T2.java b/test/langtools/tools/javac/processing/model/util/elements/overrides/T2.java deleted file mode 100644 index deb60cbd023a8..0000000000000 --- a/test/langtools/tools/javac/processing/model/util/elements/overrides/T2.java +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Copyright (c) 2023, 2024, 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. - */ - -public class T2 extends S { - - public int m() { return 0; } -} diff --git a/test/langtools/tools/javac/processing/model/util/elements/overrides/T3.java b/test/langtools/tools/javac/processing/model/util/elements/overrides/T3.java deleted file mode 100644 index 99f74093a15f1..0000000000000 --- a/test/langtools/tools/javac/processing/model/util/elements/overrides/T3.java +++ /dev/null @@ -1,27 +0,0 @@ -/* - * Copyright (c) 2023, 2024, 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. - */ - -public class T3 extends S { - - public void m() throws Exception { } -} diff --git a/test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java b/test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java index 8a25994672ee0..4646c69a6eab4 100644 --- a/test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java +++ b/test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java @@ -26,7 +26,7 @@ * @bug 8174840 * @library /tools/javac/lib * @build JavacTestingAbstractProcessor TestOverrides - * @compile -processor TestOverrides -proc:only S.java T1.java T2.java T3.java + * @compile -processor TestOverrides -proc:only S.java */ import java.util.Set; From add209c483c2a579d3c24da16099135427fc9886 Mon Sep 17 00:00:00 2001 From: Pavel Rappo Date: Thu, 21 Nov 2024 12:22:30 +0000 Subject: [PATCH 4/4] Improve characterisation testcases --- .../processing/model/util/elements/overrides/S.java | 12 +++++++++++- .../model/util/elements/overrides/TestOverrides.java | 2 +- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/test/langtools/tools/javac/processing/model/util/elements/overrides/S.java b/test/langtools/tools/javac/processing/model/util/elements/overrides/S.java index b98c27f8731e7..8ea2618b8253d 100644 --- a/test/langtools/tools/javac/processing/model/util/elements/overrides/S.java +++ b/test/langtools/tools/javac/processing/model/util/elements/overrides/S.java @@ -33,10 +33,20 @@ protected void m() { } class T2 extends S { - public int m() { return 0; } + void m() { } } class T3 extends S { + private void m() { } +} + +class T4 extends S { + + public int m() { return 0; } +} + +class T5 extends S { + public void m() throws Exception { } } diff --git a/test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java b/test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java index 4646c69a6eab4..e8cd1dac49dbf 100644 --- a/test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java +++ b/test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java @@ -46,7 +46,7 @@ public class TestOverrides extends JavacTestingAbstractProcessor { public boolean process(Set annotations, RoundEnvironment round) { if (!round.processingOver()) { var sm = mIn(elements.getTypeElement("S")); - for (var subtypeName : new String[]{"T1", "T2", "T3"}) { + for (var subtypeName : new String[]{"T1", "T2", "T3", "T4", "T5"}) { var t = elements.getTypeElement(subtypeName); var tm = mIn(t); if (!elements.overrides(tm, sm, t))