Interface YieldTree

All Superinterfaces:
ExpressionTree, Tree 
@Deprecated(since="11",
            forRemoval=true)
public interface YieldTree
extends ExpressionTree
Deprecated, for removal: This API element is subject to removal in a future version.
Nashorn JavaScript script engine and APIs, and the jjs tool are deprecated with the intent to remove them in a future release.

A tree node for yield expressions used in generator functions. For example: 

function* id(){
     var index = 0;
     while(index < 10)
         yield index++;
 }

Since:
9

Nested Classes

Nested classes/interfaces declared in interface jdk.nashorn.api.tree.Tree

Tree.Kind

Methods

Modifier and Type Method Description
ExpressionTree getExpression()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns the expression that is yielded.
boolean isStar()

Deprecated, for removal: This API element is subject to removal in a future version.

Is this a yield * expression in a generator function?

Methods declared in interface jdk.nashorn.api.tree.Tree

accept, getEndPosition, getKind, getStartPosition

Methods

getExpression

ExpressionTree getExpression()
Deprecated, for removal: This API element is subject to removal in a future version.

Returns the expression that is yielded.

Returns:
The expression that is yielded.

isStar

boolean isStar()
Deprecated, for removal: This API element is subject to removal in a future version.

Is this a yield * expression in a generator function? For example: 

function* id(){
     yield 1;
     yield * anotherGeneratorFunc();
     yield 10;
 }

Returns:
true if this is a yield * expression

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/11/docs/api/jdk.scripting.nashorn/jdk/nashorn/api/tree/YieldTree.html