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

public Class ReturnStmt

extends Statement
Class Inheritance
Imports
com.github.javaparser.ast.AllFieldsConstructor, .Node, .Generated, com.github.javaparser.ast.expr.Expression, .NameExpr, com.github.javaparser.ast.observer.ObservableProperty, com.github.javaparser.ast.visitor.GenericVisitor, .VoidVisitor, .CloneVisitor, java.util.Optional, com.github.javaparser.metamodel.OptionalProperty, .ReturnStmtMetaModel, .JavaParserMetaModel, com.github.javaparser.TokenRange, java.util.function.Consumer
The return statement, with an optional expression to return.
return 5 * 5;
Author
Julio Vilmar Gesser

Field Summary

Modifier and TypeField and Description
private Expression
expression

Constructor Summary

AccessConstructor and Description
public
ReturnStmt()

public
ReturnStmt(final Expression expression)

public
ReturnStmt(TokenRange tokenRange, Expression expression)

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

public
ReturnStmt(String expression)

Will create a NameExpr with the string param

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 ReturnStmt
asReturnStmt()

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

public ReturnStmt
clone()

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

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

public ReturnStmtMetaModel
getMetaModel()

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

public void
ifReturnStmt(Consumer<ReturnStmt> action)

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

public boolean
isReturnStmt()

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

public boolean
remove(Node node)

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

public ReturnStmt
removeExpression()

public boolean
replace(Node node, Node replacementNode)

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

public ReturnStmt

Returns:

this, the ReturnStmt
setExpression(final Expression
the expression, can be null
expression)

Sets the expression

public Optional<ReturnStmt>
toReturnStmt()

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

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

Field Detail

expressionback to summary
private Expression expression
Annotations
@OptionalProperty

Constructor Detail

ReturnStmtback to summary
public ReturnStmt()
ReturnStmtback to summary
public ReturnStmt(final Expression expression)
Annotations
@AllFieldsConstructor
ReturnStmtback to summary
public ReturnStmt(TokenRange tokenRange, Expression expression)

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

Annotations
@Generated:com.github.javaparser.generator.core.node.MainConstructorGenerator
ReturnStmtback to summary
public ReturnStmt(String expression)

Will create a NameExpr with the string param

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
asReturnStmtback to summary
public ReturnStmt asReturnStmt()

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

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.TypeCastingGenerator
cloneback to summary
public ReturnStmt 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:ReturnStmt

a clone of this instance.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator
getExpressionback to summary
public Optional<Expression> getExpression()
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getMetaModelback to summary
public ReturnStmtMetaModel getMetaModel()

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

Returns:ReturnStmtMetaModel

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

get JavaParser specific node introspection information.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator
ifReturnStmtback to summary
public void ifReturnStmt(Consumer<ReturnStmt> action)

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

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

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

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
removeExpressionback to summary
public ReturnStmt removeExpression()
Annotations
@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 ReturnStmt setExpression(final Expression expression)

Sets the expression

Parameters
expression:Expression

the expression, can be null

Returns:ReturnStmt

this, the ReturnStmt

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
toReturnStmtback to summary
public Optional<ReturnStmt> toReturnStmt()

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

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