src/jdk.compiler/share/classes/com/sun/source/tree/YieldTree.java
author jlahoda
Wed, 02 Oct 2019 10:59:40 +0200
branchJDK-8226585-branch
changeset 58440 4c8a6d1d066c
parent 58109 ee07de0d2c16
permissions -rw-r--r--
Improving appearance of javadoc of the APIs associated with preview features.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
55306
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
     1
/*
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
     2
 * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
     4
 *
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    10
 *
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    15
 * accompanied this code).
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    16
 *
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    20
 *
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    23
 * questions.
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    24
 */
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    25
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    26
package com.sun.source.tree;
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    27
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    28
/**
58440
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58109
diff changeset
    29
 * {@preview Associated with switch expressions, a preview feature of
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58109
diff changeset
    30
 *           the Java language.
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58109
diff changeset
    31
 *
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58109
diff changeset
    32
 *           This method is associated with <i>switch expressions</i>, a preview
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58109
diff changeset
    33
 *           feature of the Java language. Preview features
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58109
diff changeset
    34
 *           may be removed in a future release, or upgraded to permanent
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58109
diff changeset
    35
 *           features of the Java language.}
4c8a6d1d066c Improving appearance of javadoc of the APIs associated with preview features.
jlahoda
parents: 58109
diff changeset
    36
 *
55306
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    37
 * A tree node for a {@code yield} statement.
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    38
 *
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    39
 * For example:
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    40
 * <pre>
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    41
 *   yield <em>expression</em> ;
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    42
 * </pre>
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    43
 *
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    44
 * @jls section TODO
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    45
 *
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    46
 * @since 13
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    47
 */
58109
ee07de0d2c16 Updating javac behavior w.r.t. preview API. Based on darcy's patch.
jlahoda
parents: 55306
diff changeset
    48
@jdk.internal.PreviewFeature(feature=jdk.internal.PreviewFeature.Feature.SWITCH_EXPRESSIONS)
55306
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    49
public interface YieldTree extends StatementTree {
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    50
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    51
    /**
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    52
     * Returns the expression for this {@code yield} statement.
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    53
     *
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    54
     * @return the expression
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    55
     */
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    56
    ExpressionTree getValue();
ea43db53de91 8223305: Compiler support for Switch Expressions
jlahoda
parents:
diff changeset
    57
}