Package com.github.javaparser.ast.stmt

Class ForStmt

java.lang.Object

com.github.javaparser.ast.Node

com.github.javaparser.ast.stmt.Statement

com.github.javaparser.ast.stmt.ForStmt

All Implemented Interfaces:

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

public final class ForStmt
extends Statement
implements NodeWithBody<ForStmt>

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();

• initialization is a list of expressions. These can be any kind of expression as can be seen in example 3, but the common ones are a single VariableDeclarationExpr (which declares multiple variables) in example 1, or a list of AssignExpr's in example 2.
• compare is an expression, in example 1 and 2 it is a BinaryExpr. In example 3 there is no expression, it is empty.
• update is a list of expressions, in example 1 and 2 they are UnaryExpr's. In example 3 there is no expression, the list empty.
• body is a statement, in example 1 and 3 it is an ExpressionStmt. in example 2 it is a BlockStmt.

Author:

Julio Vilmar Gesser

See Also:

VariableDeclarationExpr

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
ForStmt()
ForStmt(NodeList<Expression> initialization, Expression compare, NodeList<Expression> update, Statement body)
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 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.
ForStmt	asForStmt()
ForStmt	clone()
Statement	getBody()
Optional<Expression>	getCompare()
NodeList<Expression>	getInitialization()
ForStmtMetaModel	getMetaModel()
NodeList<Expression>	getUpdate()
void	ifForStmt(Consumer<ForStmt> action)
boolean	isForStmt()
boolean	remove(Node node)
ForStmt	removeCompare()
boolean	replace(Node node, Node replacementNode)
ForStmt	setBody(Statement body)
ForStmt	setCompare(Expression compare)	Sets the compare
ForStmt	setInitialization(NodeList<Expression> initialization)
ForStmt	setUpdate(NodeList<Expression> update)
Optional<ForStmt>	toForStmt()

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

asAssertStmt, asBlockStmt, asBreakStmt, asContinueStmt, asDoStmt, asEmptyStmt, asExplicitConstructorInvocationStmt, asExpressionStmt, asForeachStmt, asForEachStmt, asIfStmt, asLabeledStmt, asLocalClassDeclarationStmt, asReturnStmt, asSwitchEntryStmt, asSwitchStmt, asSynchronizedStmt, asThrowStmt, asTryStmt, asUnparsableStmt, asWhileStmt, ifAssertStmt, ifBlockStmt, ifBreakStmt, ifContinueStmt, ifDoStmt, ifEmptyStmt, ifExplicitConstructorInvocationStmt, ifExpressionStmt, ifForeachStmt, ifForEachStmt, ifIfStmt, ifLabeledStmt, ifLocalClassDeclarationStmt, ifReturnStmt, ifSwitchEntryStmt, ifSwitchStmt, ifSynchronizedStmt, ifThrowStmt, ifTryStmt, ifUnparsableStmt, ifWhileStmt, isAssertStmt, isBlockStmt, isBreakStmt, isContinueStmt, isDoStmt, isEmptyStmt, isExplicitConstructorInvocationStmt, isExpressionStmt, isForeachStmt, isForEachStmt, isIfStmt, isLabeledStmt, isLocalClassDeclarationStmt, isReturnStmt, isSwitchEntryStmt, isSwitchStmt, isSynchronizedStmt, isThrowStmt, isTryStmt, isUnparsableStmt, isWhileStmt, toAssertStmt, toBlockStmt, toBreakStmt, toContinueStmt, toDoStmt, toEmptyStmt, toExplicitConstructorInvocationStmt, toExpressionStmt, toForeachStmt, toForEachStmt, toIfStmt, toLabeledStmt, toLocalClassDeclarationStmt, toReturnStmt, toSwitchEntryStmt, 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, hasComment, 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, findParent, getAncestorOfType

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

createBlockStatementAsBody

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

containsWithin, getBegin, getEnd, isPositionedAfter, isPositionedBefore

Constructor Detail

ForStmt

public ForStmt()

ForStmt

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

ForStmt

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 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<ForStmt>

getCompare

public Optional<Expression> getCompare()

getInitialization

public NodeList<Expression> getInitialization()

getUpdate

public NodeList<Expression> getUpdate()

setBody

public ForStmt setBody(Statement body)

Specified by:

setBody in interface NodeWithBody<ForStmt>

setCompare

public ForStmt setCompare(Expression compare)

Sets the compare

Parameters:

compare - the compare, can be null

Returns:

this, the ForStmt

setInitialization

public ForStmt setInitialization(NodeList<Expression> initialization)

setUpdate

public ForStmt setUpdate(NodeList<Expression> update)

remove

public boolean remove(Node node)

Overrides:

remove in class Statement

removeCompare

public ForStmt removeCompare()

clone

public ForStmt clone()

Overrides:

clone in class Statement

getMetaModel

public ForStmtMetaModel 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

isForStmt

public boolean isForStmt()

Overrides:

isForStmt in class Statement

asForStmt

public ForStmt asForStmt()

Overrides:

asForStmt in class Statement

ifForStmt

public void ifForStmt(Consumer<ForStmt> action)

Overrides:

ifForStmt in class Statement

toForStmt

public Optional<ForStmt> toForStmt()

Overrides:

toForStmt in class Statement