Package com.github.javaparser.ast.stmt

Class ForEachStmt

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.stmt.Statement

com.github.javaparser.ast.stmt.ForEachStmt

All Implemented Interfaces:

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

public class ForEachStmt
extends Statement
implements NodeWithBody<ForEachStmt>

A for-each statement.
for(Object o: objects) { ... } It was introduced in Java 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, NODE_BY_BEGIN_POSITION, prettyPrinterNoCommentsConfiguration, SYMBOL_RESOLVER_KEY

Constructor Summary

Constructors

Constructor	Description
ForEachStmt()
ForEachStmt(VariableDeclarationExpr variable, Expression iterable, Statement body)
ForEachStmt(VariableDeclarationExpr variable, String iterable, BlockStmt body)
ForEachStmt(TokenRange tokenRange, VariableDeclarationExpr variable, Expression iterable, Statement body)	This constructor is used by the parser and is considered private.

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.
ForEachStmt	asForEachStmt()
ForEachStmt	clone()
Statement	getBody()
Expression	getIterable()
ForEachStmtMetaModel	getMetaModel()
VariableDeclarationExpr	getVariable()
VariableDeclarator	getVariableDeclarator()	Convenience method that directly returns this foreach statement's single variable declarator.
boolean	hasFinalVariable()	Convenience method that decides whether this foreach statement's variable is final.
void	ifForEachStmt(Consumer<ForEachStmt> action)
boolean	isForEachStmt()
boolean	remove(Node node)
boolean	replace(Node node, Node replacementNode)
ForEachStmt	setBody(Statement body)
ForEachStmt	setIterable(Expression iterable)
ForEachStmt	setVariable(VariableDeclarationExpr variable)
Optional<ForEachStmt>	toForEachStmt()

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

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

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, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getRange, getSymbolResolver, getTokenRange, hashCode, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeComment, removeData, removeForced, removeOrphanComment, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, 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

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

createBlockStatementAsBody

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

containsWithin, getBegin, getEnd

Constructor Detail

ForEachStmt

public ForEachStmt()

ForEachStmt

public ForEachStmt(VariableDeclarationExpr variable,
                   Expression iterable,
                   Statement body)

ForEachStmt

public ForEachStmt(TokenRange tokenRange,
                   VariableDeclarationExpr variable,
                   Expression iterable,
                   Statement body)

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

ForEachStmt

public ForEachStmt(VariableDeclarationExpr variable,
                   String iterable,
                   BlockStmt body)

Method Detail

accept

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

Description copied from interface: Visitable

Accept method for visitor support.

Specified by:

accept in interface Visitable

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.

Specified by:

accept in interface Visitable

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)

getBody

public Statement getBody()

Specified by:

getBody in interface NodeWithBody<ForEachStmt>

getIterable

public Expression getIterable()

getVariable

public VariableDeclarationExpr getVariable()

setBody

public ForEachStmt setBody(Statement body)

Specified by:

setBody in interface NodeWithBody<ForEachStmt>

setIterable

public ForEachStmt setIterable(Expression iterable)

setVariable

public ForEachStmt setVariable(VariableDeclarationExpr variable)

getVariableDeclarator

public VariableDeclarator getVariableDeclarator()

Convenience method that directly returns this foreach statement's single variable declarator. Note that any foreach statement's variable declaration expression (as returned by getVariable()) always has exactly one variable declarator.

Calling this method on a foreach statement forEachStmt is equivalent to calling forEachStmt.getVariable().getVariable(0).

Returns:

this foreach statement's single variable declarator.

hasFinalVariable

public boolean hasFinalVariable()

Convenience method that decides whether this foreach statement's variable is final. Note that any foreach statement's variable declaration expression (as returned by getVariable()) always has either no modifiers, or a single final modifier.

Calling this method on a foreach statement forEachStmt is equivalent to calling forEachStmt.getVariable().getModifiers().isNonEmpty() && forEachStmt.getVariable().getModifiers().get(0).getKeyword() == Modifier.Keyword.FINAL.

Returns:

true if this foreach statement's variable is final, and false otherwise.

remove

public boolean remove(Node node)

Overrides:

remove in class Statement

clone

public ForEachStmt clone()

Overrides:

clone in class Statement

replace

public boolean replace(Node node,
                       Node replacementNode)

Overrides:

replace in class Statement

isForEachStmt

public boolean isForEachStmt()

Overrides:

isForEachStmt in class Statement

asForEachStmt

public ForEachStmt asForEachStmt()

Overrides:

asForEachStmt in class Statement

toForEachStmt

public Optional<ForEachStmt> toForEachStmt()

Overrides:

toForEachStmt in class Statement

ifForEachStmt

public void ifForEachStmt(Consumer<ForEachStmt> action)

Overrides:

ifForEachStmt in class Statement

getMetaModel

public ForEachStmtMetaModel getMetaModel()

Overrides:

getMetaModel in class Statement

Returns:

get JavaParser specific node introspection information.