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 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.BreadthFirstIterator, Node.DirectChildrenIterator, Node.ObserverRegistrationMode, Node.ParentsVisitor, Node.Parsedness, Node.PostOrderIterator, Node.PreOrderIterator, Node.TreeTraversal

Field Summary

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

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, LINE_SEPARATOR_KEY, NODE_BY_BEGIN_POSITION, prettyPrinterNoCommentsConfiguration, SYMBOL_RESOLVER_KEY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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	asReturnStmt()
ReturnStmt	clone()
Optional<Expression>	getExpression()
ReturnStmtMetaModel	getMetaModel()
void	ifReturnStmt(Consumer<ReturnStmt> action)
boolean	isReturnStmt()
boolean	remove(Node node)
ReturnStmt	removeExpression()
boolean	replace(Node node, Node replacementNode)
ReturnStmt	setExpression(Expression expression) Sets the expression
Optional<ReturnStmt>	toReturnStmt()

Methods inherited from class com.github.javaparser.ast.stmt.Statement

asAssertStmt, asBlockStmt, asBreakStmt, asContinueStmt, asDoStmt, asEmptyStmt, asExplicitConstructorInvocationStmt, asExpressionStmt, asForEachStmt, asForStmt, asIfStmt, asLabeledStmt, asLocalClassDeclarationStmt, asSwitchStmt, asSynchronizedStmt, asThrowStmt, asTryStmt, asUnparsableStmt, asWhileStmt, asYieldStmt, ifAssertStmt, ifBlockStmt, ifBreakStmt, ifContinueStmt, ifDoStmt, ifEmptyStmt, ifExplicitConstructorInvocationStmt, ifExpressionStmt, ifForEachStmt, ifForStmt, ifIfStmt, ifLabeledStmt, ifLocalClassDeclarationStmt, ifSwitchStmt, ifSynchronizedStmt, ifThrowStmt, ifTryStmt, ifUnparsableStmt, ifWhileStmt, ifYieldStmt, isAssertStmt, isBlockStmt, isBreakStmt, isContinueStmt, isDoStmt, isEmptyStmt, isExplicitConstructorInvocationStmt, isExpressionStmt, isForEachStmt, isForStmt, isIfStmt, isLabeledStmt, isLocalClassDeclarationStmt, isSwitchStmt, isSynchronizedStmt, isThrowStmt, isTryStmt, isUnparsableStmt, isWhileStmt, isYieldStmt, toAssertStmt, toBlockStmt, toBreakStmt, toContinueStmt, toDoStmt, toEmptyStmt, toExplicitConstructorInvocationStmt, toExpressionStmt, toForEachStmt, toForStmt, toIfStmt, toLabeledStmt, toLocalClassDeclarationStmt, toSwitchStmt, toSynchronizedStmt, toThrowStmt, toTryStmt, toUnparsableStmt, toWhileStmt, toYieldStmt

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

addOrphanComment, containsData, customInitialization, equals, findAll, findAll, findCompilationUnit, findFirst, findFirst, findFirst, findRootNode, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getDataKeys, getLineEndingStyle, getLineEndingStyleOrDefault, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getRange, getSymbolResolver, getTokenRange, getToStringPrettyPrinterConfiguration, hashCode, isAncestorOf, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeComment, removeData, removeForced, removeOrphanComment, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, setToStringPrettyPrinterConfiguration, stream, stream, toString, toString, tryAddImportToParentCompilationUnit, unregister, walk, walk, walk

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.javaparser.HasParentNode

findAncestor, findAncestor, isDescendantOf

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

containsWithin, containsWithinRange, getBegin, getEnd

Constructor Detail

ReturnStmt

public ReturnStmt()

ReturnStmt

public ReturnStmt(Expression expression)

ReturnStmt

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

public Optional<Expression> getExpression()

setExpression

public ReturnStmt setExpression(Expression expression)

Sets the expression

Parameters:

expression - the expression, can be null

Returns:

this, the ReturnStmt

remove

public boolean remove(Node node)

Overrides:

remove in class Statement

removeExpression

public ReturnStmt removeExpression()

clone

public ReturnStmt clone()

Overrides:

clone in class Statement

getMetaModel

public ReturnStmtMetaModel getMetaModel()

Overrides:

getMetaModel in class Statement

Returns:

get JavaParser specific node introspection information.

replace

public boolean replace(Node node,
                       Node replacementNode)

Overrides:

replace in class Statement

isReturnStmt

public boolean isReturnStmt()

Overrides:

isReturnStmt in class Statement

asReturnStmt

public ReturnStmt asReturnStmt()

Overrides:

asReturnStmt in class Statement

ifReturnStmt

public void ifReturnStmt(Consumer<ReturnStmt> action)

Overrides:

ifReturnStmt in class Statement

toReturnStmt

public Optional<ReturnStmt> toReturnStmt()

Overrides:

toReturnStmt in class Statement