Package org.eclipse.jdt.core.dom

Class YieldStatement

java.lang.Object

org.eclipse.jdt.core.dom.ASTNode

org.eclipse.jdt.core.dom.Statement

org.eclipse.jdt.core.dom.YieldStatement

public class YieldStatement
extends Statement

Yield statement AST node type.

 YieldStatement:
                Yield { Identifier/Expression }
 

Since:

3.22

Field Summary

Fields

Modifier and Type	Field	Description
static final ChildPropertyDescriptor	EXPRESSION_PROPERTY	The "expression" structural property of this node type (child type: Expression).

Fields inherited from class org.eclipse.jdt.core.dom.ASTNode

ANNOTATION_TYPE_DECLARATION, ANNOTATION_TYPE_MEMBER_DECLARATION, ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BLOCK_COMMENT, BOOLEAN_LITERAL, BREAK_STATEMENT, CASE_DEFAULT_EXPRESSION, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, CREATION_REFERENCE, DIMENSION, DO_STATEMENT, EitherOr_MultiPattern, EMPTY_STATEMENT, ENHANCED_FOR_STATEMENT, ENUM_CONSTANT_DECLARATION, ENUM_DECLARATION, EXPORTS_DIRECTIVE, EXPRESSION_METHOD_REFERENCE, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, GUARDED_PATTERN, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, INTERSECTION_TYPE, JAVADOC, JAVADOC_REGION, JAVADOC_TEXT_ELEMENT, LABELED_STATEMENT, LAMBDA_EXPRESSION, LINE_COMMENT, MALFORMED, MARKER_ANNOTATION, MEMBER_REF, MEMBER_VALUE_PAIR, METHOD_DECLARATION, METHOD_INVOCATION, METHOD_REF, METHOD_REF_PARAMETER, MODIFIER, MODULE_DECLARATION, MODULE_MODIFIER, MODULE_QUALIFIED_NAME, NAME_QUALIFIED_TYPE, NORMAL_ANNOTATION, NULL_LITERAL, NULL_PATTERN, NUMBER_LITERAL, OPENS_DIRECTIVE, ORIGINAL, PACKAGE_DECLARATION, PARAMETERIZED_TYPE, PARENTHESIZED_EXPRESSION, PATTERN_INSTANCEOF_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, PROTECT, PROVIDES_DIRECTIVE, QUALIFIED_NAME, QUALIFIED_TYPE, RECORD_DECLARATION, RECORD_PATTERN, RECOVERED, REQUIRES_DIRECTIVE, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_MEMBER_ANNOTATION, SINGLE_VARIABLE_DECLARATION, STRING_FRAGMENT, STRING_LITERAL, STRING_TEMPLATE_COMPONENT, STRING_TEMPLATE_EXPRESSION, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SUPER_METHOD_REFERENCE, SWITCH_CASE, SWITCH_EXPRESSION, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, TAG_ELEMENT, TAG_PROPERTY, TEXT_BLOCK, TEXT_ELEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, TYPE_METHOD_REFERENCE, TYPE_PARAMETER, TYPE_PATTERN, UNION_TYPE, UNNAMED_CLASS, USES_DIRECTIVE, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT, WILDCARD_TYPE, YIELD_STATEMENT

Method Summary

Modifier and Type	Method	Description
Expression	getExpression()	Returns the expression of this Yield statement, or null if there is none.
boolean	isImplicit()	Gets the isImplicit of this break statement as true or false.
static List	propertyDescriptors(int apiLevel)	Returns a list of structural property descriptors for this node type.
void	setExpression(Expression expression)	Sets or clears the expression of this Yield statement.

Methods inherited from class org.eclipse.jdt.core.dom.Statement

getLeadingComment, setLeadingComment

Methods inherited from class org.eclipse.jdt.core.dom.ASTNode

accept, copySubtree, copySubtrees, delete, equals, getAST, getFlags, getLength, getLocationInParent, getNodeType, getParent, getProperty, getRoot, getStartPosition, getStructuralProperty, hashCode, nodeClassForType, properties, setFlags, setProperty, setSourceRange, setStructuralProperty, structuralPropertiesForType, subtreeBytes, subtreeMatch, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EXPRESSION_PROPERTY

public static final ChildPropertyDescriptor EXPRESSION_PROPERTY

The "expression" structural property of this node type (child type: Expression). (added in JEP 354).

Method Details

propertyDescriptors

public static List propertyDescriptors(int apiLevel)

Returns a list of structural property descriptors for this node type. Clients must not modify the result.

Parameters:

apiLevel - the API level; one of the AST.JLS* constants

Returns:

a list of property descriptors (element type: StructuralPropertyDescriptor)

Since:

3.22

getExpression

public Expression getExpression()

Returns the expression of this Yield statement, or null if there is none.

Returns:

the expression, or null if there is none

Throws:

UnsupportedOperationException - if this operation is used below JLS14

Since:

3.22

setExpression

public void setExpression(Expression expression)

Sets or clears the expression of this Yield statement.

Parameters:

expression - the expression

Throws:

IllegalArgumentException - if:

• the node belongs to a different AST
• the node already has a parent

UnsupportedOperationException - if this operation is used below JLS14

Since:

3.22

isImplicit

public boolean isImplicit()

Gets the isImplicit of this break statement as true or false. true indicates implicit and false indicates not implicit.

Returns:

isImplicit true or false

Throws:

UnsupportedOperationException - if this operation is used below JLS14

Since:

3.22