src/jdk.compiler/share/classes/com/sun/source/tree/InstanceOfTree.java
author jlahoda
Wed, 27 Nov 2019 09:00:01 +0100
changeset 59285 7799a51dbe30
parent 54817 ef73702a906e
permissions -rw-r--r--
8231826: Implement javac changes for pattern matching for instanceof Reviewed-by: mcimadamore Contributed-by: brian.goetz@oracle.com, gavin.bierman@oracle.com, maurizio.cimadamore@oracle.com, srikanth.adayapalam@oracle.com, vicente.romero@oracle.com, jan.lahoda@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
59285
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
     2
 * Copyright (c) 2005, 2019, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    23
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
package com.sun.source.tree;
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
/**
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    29
 * A tree node for an {@code instanceof} expression.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
 * For example:
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
 * <pre>
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
 *   <em>expression</em> instanceof <em>type</em>
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
 * </pre>
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
 *
54817
ef73702a906e 8223654: Clean up @jls references in com.sun.source
jjg
parents: 47216
diff changeset
    36
 * @jls 15.20.2 Type Comparison Operator instanceof
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
 * @author Peter von der Ah&eacute;
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
 * @author Jonathan Gibbons
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
 * @since 1.6
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
public interface InstanceOfTree extends ExpressionTree {
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    43
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    44
     * Returns the expression to be tested.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    45
     * @return the expression
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    46
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
    ExpressionTree getExpression();
25287
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    48
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    49
    /**
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    50
     * Returns the type for which to check.
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    51
     * @return the type
d2440361b323 8046614: Fill in missing doc comments
jjg
parents: 20612
diff changeset
    52
     */
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
    Tree getType();
59285
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    54
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    55
    /**
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    56
     * {@preview Associated with pattern matching for instanceof, a preview feature of
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    57
     *           the Java language.
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    58
     *
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    59
     *           This method is associated with <i>pattern matching for instanceof</i>, a preview
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    60
     *           feature of the Java language. Preview features
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    61
     *           may be removed in a future release, or upgraded to permanent
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    62
     *           features of the Java language.}
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    63
     *
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    64
     * Returns the tested pattern, or null if this instanceof does not use
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    65
     * a pattern.
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    66
     *
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    67
     * <p>For instanceof with a pattern, i.e. in the following form:
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    68
     * <pre>
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    69
     *   <em>expression</em> instanceof <em>type</em> <em>variable name</em>
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    70
     * </pre>
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    71
     * returns the pattern.
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    72
     *
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    73
     * <p>For instanceof without a pattern, i.e. in the following form:
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    74
     * <pre>
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    75
     *   <em>expression</em> instanceof <em>type</em>
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    76
     * </pre>
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    77
     * returns null.
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    78
     *
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    79
     * @return the tested pattern, or null if this instanceof does not use a pattern.
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    80
     * @since 14
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    81
     */
7799a51dbe30 8231826: Implement javac changes for pattern matching for instanceof
jlahoda
parents: 54817
diff changeset
    82
    PatternTree getPattern();
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
}