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

public Class ForStmt

extends Statement
implements NodeWithBody<ForStmt>
Class Inheritance
All Implemented Interfaces
com.github.javaparser.ast.nodeTypes.NodeWithBody
Imports
com.github.javaparser.TokenRange, com.github.javaparser.ast.AllFieldsConstructor, .Node, .NodeList, .Generated, com.github.javaparser.ast.expr.BooleanLiteralExpr, .Expression, com.github.javaparser.ast.nodeTypes.NodeWithBody, com.github.javaparser.ast.observer.ObservableProperty, com.github.javaparser.ast.visitor.CloneVisitor, .GenericVisitor, .VoidVisitor, com.github.javaparser.metamodel.ForStmtMetaModel, .JavaParserMetaModel, .OptionalProperty, java.util.Optional, java.util.function.Consumer

The classic for statement

Examples:
  1. for(int a=3, b=5; a<99; a++, b++) hello();
  2. for(a=3, b=5; a<99; a++) { hello(); }
  3. for(a(),b();;) hello();
Author
Julio Vilmar Gesser
See Also
com.github.javaparser.ast.expr.VariableDeclarationExpr

Field Summary

Modifier and TypeField and Description
private Statement
body

private Expression
compare

private NodeList<Expression>
initialization

private NodeList<Expression>
update

Constructor Summary

AccessConstructor and Description
public
ForStmt()

public
ForStmt(final NodeList<Expression> initialization, final Expression compare, final NodeList<Expression> update, final Statement body)

public
ForStmt(TokenRange tokenRange, NodeList<Expression> initialization, Expression compare, NodeList<Expression> update, Statement body)

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

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 ForStmt
asForStmt()

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

public ForStmt
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 Optional<Expression>
getCompare()

public NodeList<Expression>
getInitialization()

public ForStmtMetaModel
getMetaModel()

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

public NodeList<Expression>
getUpdate()

public void
ifForStmt(Consumer<ForStmt> action)

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

public boolean
isForStmt()

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

public boolean
remove(Node node)

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

public ForStmt
removeCompare()

public boolean
replace(Node node, Node replacementNode)

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

public ForStmt
setBody(final Statement body)

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

public ForStmt

Returns:

this, the ForStmt
setCompare(final Expression
the compare, can be null
compare)

Sets the compare

public ForStmt
setInitialization(final NodeList<Expression> initialization)

public ForStmt
setUpdate(final NodeList<Expression> update)

public Optional<ForStmt>
toForStmt()

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

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

Field Detail

bodyback to summary
private Statement body
compareback to summary
private Expression compare
Annotations
@OptionalProperty
initializationback to summary
private NodeList<Expression> initialization
updateback to summary
private NodeList<Expression> update

Constructor Detail

ForStmtback to summary
public ForStmt()
ForStmtback to summary
public ForStmt(final NodeList<Expression> initialization, final Expression compare, final NodeList<Expression> update, final Statement body)
Annotations
@AllFieldsConstructor
ForStmtback to summary
public ForStmt(TokenRange tokenRange, NodeList<Expression> initialization, Expression compare, NodeList<Expression> update, Statement body)

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

Annotations
@Generated:com.github.javaparser.generator.core.node.MainConstructorGenerator

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
asForStmtback to summary
public ForStmt asForStmt()

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

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

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
getCompareback to summary
public Optional<Expression> getCompare()
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getInitializationback to summary
public NodeList<Expression> getInitialization()
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
getMetaModelback to summary
public ForStmtMetaModel getMetaModel()

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

Returns:ForStmtMetaModel

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

get JavaParser specific node introspection information.

Annotations
@Override
@Generated:com.github.javaparser.generator.core.node.GetMetaModelGenerator
getUpdateback to summary
public NodeList<Expression> getUpdate()
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
ifForStmtback to summary
public void ifForStmt(Consumer<ForStmt> action)

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

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

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

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

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

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setCompareback to summary
public ForStmt setCompare(final Expression compare)

Sets the compare

Parameters
compare:Expression

the compare, can be null

Returns:ForStmt

this, the ForStmt

Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setInitializationback to summary
public ForStmt setInitialization(final NodeList<Expression> initialization)
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
setUpdateback to summary
public ForStmt setUpdate(final NodeList<Expression> update)
Annotations
@Generated:com.github.javaparser.generator.core.node.PropertyGenerator
toForStmtback to summary
public Optional<ForStmt> toForStmt()

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

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