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 72c5802a5c8..b548afe8a77 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 @@ -662,6 +662,13 @@ public interface Elements { * elements.getTypeElement("C")); } * * + * @implNote The notion of overriding, by itself, does not involve method + * return type, listed exceptions, and, to some extent, access modifiers. + * If one method is found to override another, they are subject to additional + * requirements to be checked by the compiler; see {@jls 8.4.8.3}. + * If reflected source is not compiled -- as might, for example, happen when + * only processing annotations -- this method might return false positives. + * * @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 00000000000..0b01cb41033 --- /dev/null +++ b/test/langtools/tools/javac/processing/model/util/elements/overrides/S.java @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2023, 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 00000000000..3fa7c9c31ea --- /dev/null +++ b/test/langtools/tools/javac/processing/model/util/elements/overrides/T1.java @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2023, 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 00000000000..677df6eef65 --- /dev/null +++ b/test/langtools/tools/javac/processing/model/util/elements/overrides/T2.java @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2023, 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 00000000000..84fad40cf8c --- /dev/null +++ b/test/langtools/tools/javac/processing/model/util/elements/overrides/T3.java @@ -0,0 +1,27 @@ +/* + * Copyright (c) 2023, 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 00000000000..adc634248f5 --- /dev/null +++ b/test/langtools/tools/javac/processing/model/util/elements/overrides/TestOverrides.java @@ -0,0 +1,69 @@ +/* + * Copyright (c) 2023, 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(); + } +}