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>

A classic for statement.
In for(int a=3,b==5; a<99; a++) { ... } the intialization is int a=3,b=5, compare is b==5, update is a++, and the statement or block statement following it is in body.

Author:

Julio Vilmar Gesser

Nested Class Summary

Nested classes/interfaces inherited from class com.github.javaparser.ast.Node

Node.ObserverRegistrationMode, Node.Parsedness

Field Summary

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

ABSOLUTE_BEGIN_LINE, ABSOLUTE_END_LINE, NODE_BY_BEGIN_POSITION, prettyPrinterNoCommentsConfiguration

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	clone()
Statement	getBody()
Optional<Expression>	getCompare()
NodeList<Expression>	getInitialization()
ForStmtMetaModel	getMetaModel()
List<NodeList<?>>	getNodeLists()	The list of NodeLists owned by this node.
NodeList<Expression>	getUpdate()
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)

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

addOrphanComment, customInitialization, equals, getAllContainedComments, getChildNodes, getChildNodesByType, getComment, getData, getNodesByType, getOrphanComments, getParentNode, getParentNodeForChildren, getParsed, getRange, getTokenRange, hasComment, hashCode, isRegistered, notifyPropertyChange, register, register, registerForSubtree, remove, removeComment, removeForced, removeOrphanComment, replace, setAsParentNodeOf, setAsParentNodeOf, setBlockComment, setComment, setData, setLineComment, setParentNode, setParsed, setRange, setTokenRange, toString, toString, tryAddImportToParentCompilationUnit, unregister

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.javaparser.HasParentNode

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

@Generated("com.github.javaparser.generator.core.node.MainConstructorGenerator")
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

@Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
public Statement getBody()

Specified by:

getBody in interface NodeWithBody<ForStmt>

getCompare

@Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
public Optional<Expression> getCompare()

getInitialization

@Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
public NodeList<Expression> getInitialization()

getUpdate

@Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
public NodeList<Expression> getUpdate()

setBody

@Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
public ForStmt setBody(Statement body)

Specified by:

setBody in interface NodeWithBody<ForStmt>

setCompare

@Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
public ForStmt setCompare(Expression compare)

Sets the compare

Parameters:

compare - the compare, can be null

Returns:

this, the ForStmt

setInitialization

@Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
public ForStmt setInitialization(NodeList<Expression> initialization)

setUpdate

@Generated("com.github.javaparser.generator.core.node.PropertyGenerator")
public ForStmt setUpdate(NodeList<Expression> update)

getNodeLists

@Generated("com.github.javaparser.generator.core.node.GetNodeListsGenerator")
public List<NodeList<?>> getNodeLists()

Description copied from class: Node

The list of NodeLists owned by this node.

Overrides:

getNodeLists in class Node

remove

@Generated("com.github.javaparser.generator.core.node.RemoveMethodGenerator")
public boolean remove(Node node)

Overrides:

remove in class Statement

removeCompare

@Generated("com.github.javaparser.generator.core.node.RemoveMethodGenerator")
public ForStmt removeCompare()

clone

@Generated("com.github.javaparser.generator.core.node.CloneGenerator")
public ForStmt clone()

Overrides:

clone in class Statement

getMetaModel

@Generated("com.github.javaparser.generator.core.node.GetMetaModelGenerator")
public ForStmtMetaModel getMetaModel()

Overrides:

getMetaModel in class Statement

Returns:

get JavaParser specific node introspection information.

replace

@Generated("com.github.javaparser.generator.core.node.ReplaceMethodGenerator")
public boolean replace(Node node,
                       Node replacementNode)

Overrides:

replace in class Statement