Package com.github.javaparser.ast.stmt

Class ReturnStmt

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.stmt.Statement

com.github.javaparser.ast.stmt.ReturnStmt

All Implemented Interfaces:

NodeWithRange<Node>, NodeWithTokenRange<Node>, Observable, Visitable, HasParentNode<Node>, Cloneable

public final class ReturnStmt
extends Statement

The return statement, with an optional expression to return.
return 5 * 5;

Author:

Julio Vilmar Gesser

Nested Class Summary

Nested classes/interfaces inherited from class com.github.javaparser.ast.Node

Node.ObserverRegistrationMode, Node.Parsedness

Field Summary

Fields inherited from class com.github.javaparser.ast.Node

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, NODE_BY_BEGIN_POSITION, prettyPrinterNoCommentsConfiguration

Constructor Summary

Constructors

Constructor	Description
ReturnStmt()
ReturnStmt(Expression expression)
ReturnStmt(TokenRange tokenRange, Expression expression)	This constructor is used by the parser and is considered private.
ReturnStmt(String expression)	Will create a NameExpr with the string param

Method Summary

Modifier and Type	Method	Description
<R,A> R	accept(GenericVisitor<R,A> v, A arg)	Accept method for visitor support.
<A> void	accept(VoidVisitor<A> v, A arg)	Accept method for visitor support.
ReturnStmt	clone()
Optional<Expression>	getExpression()
ReturnStmtMetaModel	getMetaModel()
boolean	remove(Node node)
ReturnStmt	removeExpression()
boolean	replace(Node node, Node replacementNode)
ReturnStmt	setExpression(Expression expression)	Sets the expression

Methods inherited from interface com.github.javaparser.HasParentNode

getAncestorOfType

Methods inherited from class com.github.javaparser.ast.Node

addOrphanComment, customInitialization, equals, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getNodeLists, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getRange, getTokenRange, hasComment, hashCode, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeComment, removeForced, removeOrphanComment, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, toString, toString, tryAddImportToParentCompilationUnit, unregister

Methods inherited from interface com.github.javaparser.ast.nodeTypes.NodeWithRange

containsWithin, getBegin, getEnd, isPositionedAfter, isPositionedBefore

Methods inherited from class java.lang.Object

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

Constructor Detail

ReturnStmt

public ReturnStmt()

ReturnStmt

public ReturnStmt(Expression expression)

ReturnStmt

@Generated("com.github.javaparser.generator.core.node.MainConstructorGenerator")
public ReturnStmt(TokenRange tokenRange,
                  Expression expression)

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

ReturnStmt

public ReturnStmt(String expression)

Will create a NameExpr with the string param

Method Detail

accept

public <R,A> R accept(GenericVisitor<R,A> v,
                      A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Type Parameters:

R - the type of the return value of the visitor

A - the type the user argument passed to the visitor

Parameters:

v - the visitor implementation

arg - the argument passed to the visitor (of type A)

Returns:

the result of the visit (of type R)

accept

public <A> void accept(VoidVisitor<A> v,
                       A arg)

Description copied from interface: Visitable

Accept method for visitor support.

Type Parameters:

A - the type the argument passed for the visitor

Parameters:

v - the visitor implementation

arg - any value relevant for the visitor (of type A)

getExpression

@Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
public Optional<Expression> getExpression()

setExpression

@Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
public ReturnStmt setExpression(Expression expression)

Sets the expression

Parameters:

expression - the expression, can be null

Returns:

this, the ReturnStmt

remove

@Generated("com.github.javaparser.generator.core.node.RemoveMethodGenerator")
public boolean remove(Node node)

Overrides:

remove in class Statement

removeExpression

@Generated("com.github.javaparser.generator.core.node.RemoveMethodGenerator")
public ReturnStmt removeExpression()

clone

@Generated("com.github.javaparser.generator.core.node.CloneGenerator")
public ReturnStmt clone()

Overrides:

clone in class Statement

getMetaModel

@Generated("com.github.javaparser.generator.core.node.GetMetaModelGenerator")
public ReturnStmtMetaModel getMetaModel()

Overrides:

getMetaModel in class Statement

Returns:

get JavaParser specific node introspection information.

replace

@Generated("com.github.javaparser.generator.core.node.ReplaceMethodGenerator")
public boolean replace(Node node,
                       Node replacementNode)

Overrides:

replace in class Statement