Top Description Fields Constructors Methods
com.github.javaparser.ast.stmt

public Class YieldStmt

extends Statement
implements NodeWithExpression
Class Inheritance
All Implemented Interfaces
com.github.javaparser.ast.nodeTypes.NodeWithExpression
Imports
com.github.javaparser.TokenRange, com.github.javaparser.ast.AllFieldsConstructor, .Generated, .Node, com.github.javaparser.ast.expr.Expression, .NameExpr, com.github.javaparser.ast.nodeTypes.NodeWithExpression, com.github.javaparser.ast.observer.ObservableProperty, com.github.javaparser.ast.visitor.GenericVisitor, .VoidVisitor, .CloneVisitor, java.util.Optional, java.util.function.Consumer, com.github.javaparser.metamodel.YieldStmtMetaModel, .JavaParserMetaModel

The yield statement

Java 1.0-11

Does not exist.

Java 12

Yields an expression to be used in the switch-expression:
yield 123+456;
yield "more or less";

Field Summary

Modifier and TypeField and Description
private Expression
expression

Constructor Summary

AccessConstructor and Description
public
YieldStmt()

public
YieldStmt(final Expression expression)

public
YieldStmt(TokenRange tokenRange, Expression expression)

This constructor is used by the parser and is considered private.

Method Summary

Modifier and TypeMethod and Description
public <R, A> R
accept(final GenericVisitor<R, A>
the visitor implementation
v, final A
the argument passed to the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public <A> void
accept(final VoidVisitor<A>
the visitor implementation
v, final A
any value relevant for the visitor (of type A)
arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.
public YieldStmt
asYieldStmt()

Overrides com.github.javaparser.ast.stmt.Statement.asYieldStmt.

public YieldStmt
clone()

Overrides com.github.javaparser.ast.stmt.Statement.clone.

Creates and returns a copy of this object.
public Expression
getExpression()

Implements com.github.javaparser.ast.nodeTypes.NodeWithExpression.getExpression.

public YieldStmtMetaModel
getMetaModel()

Overrides com.github.javaparser.ast.stmt.Statement.getMetaModel.

public void
ifYieldStmt(Consumer<YieldStmt> action)

Overrides com.github.javaparser.ast.stmt.Statement.ifYieldStmt.

public boolean
isYieldStmt()

Overrides com.github.javaparser.ast.stmt.Statement.isYieldStmt.

public boolean
remove(Node node)

Overrides com.github.javaparser.ast.stmt.Statement.remove.

public boolean
replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.stmt.Statement.replace.

public YieldStmt

Returns:

this, the YieldStmt
setExpression(final Expression
the label or the expression, can be null
expression)

Implements com.github.javaparser.ast.nodeTypes.NodeWithExpression.setExpression.

Sets the label
public Optional<YieldStmt>
toYieldStmt()

Overrides com.github.javaparser.ast.stmt.Statement.toYieldStmt.

Inherited from com.github.javaparser.ast.stmt.Statement:
asAssertStmtasBlockStmtasBreakStmtasContinueStmtasDoStmtasEmptyStmtasExplicitConstructorInvocationStmtasExpressionStmtasForEachStmtasForStmtasIfStmtasLabeledStmtasLocalClassDeclarationStmtasReturnStmtasSwitchStmtasSynchronizedStmtasThrowStmtasTryStmtasUnparsableStmtasWhileStmtifAssertStmtifBlockStmtifBreakStmtifContinueStmtifDoStmtifEmptyStmtifExplicitConstructorInvocationStmtifExpressionStmtifForEachStmtifForStmtifIfStmtifLabeledStmtifLocalClassDeclarationStmtifReturnStmtifSwitchStmtifSynchronizedStmtifThrowStmtifTryStmtifUnparsableStmtifWhileStmtisAssertStmtisBlockStmtisBreakStmtisContinueStmtisDoStmtisEmptyStmtisExplicitConstructorInvocationStmtisExpressionStmtisForEachStmtisForStmtisIfStmtisLabeledStmtisLocalClassDeclarationStmtisReturnStmtisSwitchStmtisSynchronizedStmtisThrowStmtisTryStmtisUnparsableStmtisWhileStmttoAssertStmttoBlockStmttoBreakStmttoContinueStmttoDoStmttoEmptyStmttoExplicitConstructorInvocationStmttoExpressionStmttoForEachStmttoForStmttoIfStmttoLabeledStmttoLocalClassDeclarationStmttoReturnStmttoSwitchStmttoSynchronizedStmttoThrowStmttoTryStmttoUnparsableStmttoWhileStmt

Field Detail

expressionback to summary
private Expression expression

Constructor Detail

YieldStmtback to summary
public YieldStmt()
YieldStmtback to summary
public YieldStmt(final Expression expression)
Annotations
@AllFieldsConstructor
YieldStmtback to summary
public YieldStmt(TokenRange tokenRange, Expression expression)

This constructor is used by the parser and is considered private.

Annotations
@Generated:com.github.javaparser.generator.core.node.MainConstructorGenerator

Method Detail

acceptback to summary
public <R, A> R accept(final GenericVisitor<R, A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<R>
the type of the return value of the visitor
<A>
the type the user argument passed to the visitor
v:GenericVisitor<R, A>

the visitor implementation

arg:A

the argument passed to the visitor (of type A)

Returns:R

the result of the visit (of type R)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
acceptback to summary
public <A> void accept(final VoidVisitor<A> v, final A arg)

Implements com.github.javaparser.ast.visitor.Visitable.accept.

Doc from com.github.javaparser.ast.visitor.Visitable.accept.

Accept method for visitor support.

Parameters
<A>
the type the argument passed for the visitor
v:VoidVisitor<A>

the visitor implementation

arg:A

any value relevant for the visitor (of type A)

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.AcceptGenerator
asYieldStmtback to summary
public YieldStmt asYieldStmt()

Overrides com.github.javaparser.ast.stmt.Statement.asYieldStmt.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
cloneback to summary
public YieldStmt clone()

Overrides com.github.javaparser.ast.stmt.Statement.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression: 

x.clone() != x
will be true, and that the expression: 
x.clone().getClass() == x.getClass()
will be true, but these are not absolute requirements. While it is typically the case that: 
x.clone().equals(x)
will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:YieldStmt

a clone of this instance.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator
getExpressionback to summary
public Expression getExpression()

Implements com.github.javaparser.ast.nodeTypes.NodeWithExpression.getExpression.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getMetaModelback to summary
public YieldStmtMetaModel getMetaModel()

Overrides com.github.javaparser.ast.stmt.Statement.getMetaModel.

Returns:YieldStmtMetaModel

Doc from com.github.javaparser.ast.Node.getMetaModel.

get JavaParser specific node introspection information.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator
ifYieldStmtback to summary
public void ifYieldStmt(Consumer<YieldStmt> action)

Overrides com.github.javaparser.ast.stmt.Statement.ifYieldStmt.

Annotations
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
isYieldStmtback to summary
public boolean isYieldStmt()

Overrides com.github.javaparser.ast.stmt.Statement.isYieldStmt.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
removeback to summary
public boolean remove(Node node)

Overrides com.github.javaparser.ast.stmt.Statement.remove.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.RemoveMethodGenerator
replaceback to summary
public boolean replace(Node node, Node replacementNode)

Overrides com.github.javaparser.ast.stmt.Statement.replace.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.ReplaceMethodGenerator
setExpressionback to summary
public YieldStmt setExpression(final Expression expression)

Implements com.github.javaparser.ast.nodeTypes.NodeWithExpression.setExpression.

Sets the label

Parameters
expression:Expression

the label or the expression, can be null

Returns:YieldStmt

this, the YieldStmt

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
toYieldStmtback to summary
public Optional<YieldStmt> toYieldStmt()

Overrides com.github.javaparser.ast.stmt.Statement.toYieldStmt.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator