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

public Class ForEachStmt

extends Statement
implements NodeWithBody<ForEachStmt>
Class Inheritance
All Implemented Interfaces
com.github.javaparser.ast.nodeTypes.NodeWithBody
Imports
com.github.javaparser.TokenRange, com.github.javaparser.ast.AllFieldsConstructor, .Generated, .Modifier, .Node, com.github.javaparser.ast.body.VariableDeclarator, com.github.javaparser.ast.expr.Expression, .NameExpr, .VariableDeclarationExpr, com.github.javaparser.ast.nodeTypes.NodeWithBody, com.github.javaparser.ast.observer.ObservableProperty, com.github.javaparser.ast.visitor.CloneVisitor, .GenericVisitor, .VoidVisitor, com.github.javaparser.metamodel.ForEachStmtMetaModel, .JavaParserMetaModel, java.util.Optional, java.util.function.Consumer
A for-each statement.
for(Object o: objects) { ... } It was introduced in Java 5.
Author
Julio Vilmar Gesser

Field Summary

Modifier and TypeField and Description
private Statement
body

private Expression
iterable

private VariableDeclarationExpr
variable

Constructor Summary

AccessConstructor and Description
public
ForEachStmt()

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

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

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

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

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 ForEachStmt
asForEachStmt()

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

public ForEachStmt
clone()

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

Creates and returns a copy of this object.
public Statement
getBody()

Implements com.github.javaparser.ast.nodeTypes.NodeWithBody.getBody.

public Expression
getIterable()

public ForEachStmtMetaModel
getMetaModel()

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

public VariableDeclarationExpr
getVariable()

public VariableDeclarator

Returns:

this foreach statement's single variable declarator.
getVariableDeclarator()

Convenience method that directly returns this foreach statement's single variable declarator.

public boolean

Returns:

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

Convenience method that decides whether this foreach statement's variable is final.

public void
ifForEachStmt(Consumer<ForEachStmt> action)

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

public boolean
isForEachStmt()

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

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 ForEachStmt
setBody(final Statement body)

Implements com.github.javaparser.ast.nodeTypes.NodeWithBody.setBody.

public ForEachStmt
setIterable(final Expression iterable)

public ForEachStmt
setVariable(final VariableDeclarationExpr variable)

public Optional<ForEachStmt>
toForEachStmt()

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

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

Field Detail

bodyback to summary
private Statement body
iterableback to summary
private Expression iterable
variableback to summary
private VariableDeclarationExpr variable

Constructor Detail

ForEachStmtback to summary
public ForEachStmt()
ForEachStmtback to summary
public ForEachStmt(final VariableDeclarationExpr variable, final Expression iterable, final Statement body)
Annotations
@AllFieldsConstructor
ForEachStmtback to summary
public ForEachStmt(TokenRange tokenRange, VariableDeclarationExpr variable, Expression iterable, Statement body)

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

Annotations
@Generated:com.github.javaparser.generator.core.node.MainConstructorGenerator
ForEachStmtback to summary
public ForEachStmt(VariableDeclarationExpr variable, String iterable, BlockStmt body)

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
asForEachStmtback to summary
public ForEachStmt asForEachStmt()

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

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

a clone of this instance.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.CloneGenerator
getBodyback to summary
public Statement getBody()

Implements com.github.javaparser.ast.nodeTypes.NodeWithBody.getBody.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getIterableback to summary
public Expression getIterable()
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getMetaModelback to summary
public ForEachStmtMetaModel getMetaModel()

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

Returns:ForEachStmtMetaModel

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

get JavaParser specific node introspection information.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator
getVariableback to summary
public VariableDeclarationExpr getVariable()
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getVariableDeclaratorback to summary
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:VariableDeclarator

this foreach statement's single variable declarator.

hasFinalVariableback to summary
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:boolean

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

ifForEachStmtback to summary
public void ifForEachStmt(Consumer<ForEachStmt> action)

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

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

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

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
setBodyback to summary
public ForEachStmt setBody(final Statement body)

Implements com.github.javaparser.ast.nodeTypes.NodeWithBody.setBody.

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setIterableback to summary
public ForEachStmt setIterable(final Expression iterable)
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setVariableback to summary
public ForEachStmt setVariable(final VariableDeclarationExpr variable)
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
toForEachStmtback to summary
public Optional<ForEachStmt> toForEachStmt()

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

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