8348906: InstanceOfTree#getType doesn't specify when it returns null

Reviewed-by: liach
This commit is contained in:
Jan Lahoda 2025-05-20 02:40:05 +00:00
parent 890456f0f7
commit 39d8d109dd
2 changed files with 120 additions and 7 deletions

View File

@ -31,6 +31,8 @@ package com.sun.source.tree;
* For example:
* <pre>
* <em>expression</em> instanceof <em>type</em>
*
* <em>expression</em> instanceof <em>pattern</em>
* </pre>
*
* @jls 15.20.2 The instanceof Operator
@ -48,29 +50,50 @@ public interface InstanceOfTree extends ExpressionTree {
ExpressionTree getExpression();
/**
* Returns the type for which to check.
* @return the type
* Returns the type for which to check, or {@code null} if this {@code instanceof}
* uses a pattern other the {@link BindingPatternTree}.
*
* <p>For {@code instanceof} without a pattern, i.e. in the following form:
* <pre>
* <em>expression</em> instanceof <em>type</em>
* </pre>
* returns the type.
*
* <p>For {@code instanceof} with a {@link BindingPatternTree}, i.e. in the following form:
* <pre>
* <em>expression</em> instanceof <em>type</em> <em>variable_name</em>
* </pre>
* returns the type.
*
* <p>For instanceof with a pattern, i.e. in the following form:
* <pre>
* <em>expression</em> instanceof <em>pattern</em>
* </pre>
* returns {@code null}.
*
* @return the type or {@code null} if this {@code instanceof} uses a pattern other than
* the {@linkplain BindingPatternTree}
* @see #getPattern()
*/
Tree getType();
/**
* Returns the tested pattern, or null if this instanceof does not use
* Returns the tested pattern, or {@code null} if this {@code instanceof} does not use
* a pattern.
*
* <p>For instanceof with a pattern, i.e. in the following form:
* <pre>
* <em>expression</em> instanceof <em>type</em> <em>variable name</em>
* <em>expression</em> instanceof <em>pattern</em>
* </pre>
* returns the pattern.
*
* <p>For instanceof without a pattern, i.e. in the following form:
* <p>For {@code instanceof} without a pattern, i.e. in the following form:
* <pre>
* <em>expression</em> instanceof <em>type</em>
* </pre>
* returns null.
* returns {@code null}.
*
* @return the tested pattern, or null if this instanceof does not use a pattern
* @return the tested pattern, or {@code null} if this {@code instanceof} does not use a pattern
* @since 16
*/
PatternTree getPattern();

View File

@ -0,0 +1,90 @@
/*
* Copyright (c) 2025, 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 8348906
* @summary Verify the InstanceOfTree model
*/
import com.sun.source.tree.CompilationUnitTree;
import com.sun.source.tree.InstanceOfTree;
import com.sun.source.util.JavacTask;
import com.sun.source.util.TreeScanner;
import java.net.URI;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import javax.tools.JavaCompiler;
import javax.tools.JavaFileObject;
import javax.tools.SimpleJavaFileObject;
import javax.tools.ToolProvider;
public class InstanceOfModelTest {
private final JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
public static void main(String... args) throws Exception {
new InstanceOfModelTest().run();
}
private void run() throws Exception {
JavaFileObject input =
SimpleJavaFileObject.forSource(URI.create("mem://Test.java"),
"""
public class Test {
void test(Object o) {
boolean _ = o instanceof R;
boolean _ = o instanceof R r;
boolean _ = o instanceof R(var v);
}
record R(int i) {}
}
""");
JavacTask task =
(JavacTask) compiler.getTask(null, null, null, null, null, List.of(input));
CompilationUnitTree cut = task.parse().iterator().next();
task.analyze();
List<String> instanceOf = new ArrayList<>();
new TreeScanner<Void, Void>() {
@Override
public Void visitInstanceOf(InstanceOfTree node, Void p) {
instanceOf.add(node.getPattern() + ":" + node.getType());
return super.visitInstanceOf(node, p);
}
}.scan(cut, null);
List<String> expectedInstanceOf = List.of(
"null:R",
"R r:R",
"R(int v):null"
);
if (!Objects.equals(expectedInstanceOf, instanceOf)) {
throw new AssertionError("Expected: " + expectedInstanceOf + ",\n" +
"got: " + instanceOf);
}
}
}