Package net.sourceforge.pmd.lang.java.ast

Class ASTForStatement

java.lang.Object

net.sourceforge.pmd.lang.ast.AbstractNode

net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<JavaNode>

net.sourceforge.pmd.lang.java.ast.AbstractJavaNode

net.sourceforge.pmd.lang.java.ast.ASTForStatement

All Implemented Interfaces:

net.sourceforge.pmd.lang.ast.Node, JavaNode, net.sourceforge.pmd.lang.symboltable.ScopedNode

public class ASTForStatement
extends AbstractJavaNode

Represents a for-loop, or a foreach loop.

 ForStatement ::= "for" "(" LocalVariableDeclaration ":" Expression ")" Statement
                | "for" "(" ForInit? ";" Expression? ";" ForUpdate? ")" Statement

 

Field Summary

Fields inherited from class net.sourceforge.pmd.lang.java.ast.AbstractJavaNode

parser

Fields inherited from class net.sourceforge.pmd.lang.ast.AbstractNode

beginColumn, beginLine, childIndex, children, endColumn, endLine, firstToken, id, lastToken, parent

Constructor Summary

Constructors

Constructor	Description
ASTForStatement(int id)	Deprecated.
ASTForStatement(JavaParser p, int id)	Deprecated.

Method Summary

Modifier and Type	Method	Description
ASTStatement	getBody()	Returns the statement that represents the body of this loop.
ASTExpression	getCondition()	Returns the node that represents the guard of this loop.
ASTExpression	getGuardExpressionNode()	Deprecated. Use getCondition()
boolean	isForeach()	Returns true if this node represents a foreach loop.
Object	jjtAccept(JavaParserVisitor visitor, Object data)	Calls back the visitor's visit method corresponding to the runtime type of this Node.

Methods inherited from class net.sourceforge.pmd.lang.java.ast.AbstractJavaNode

childrenAccept, comment, comment, getScope, getXPathNodeName, jjtClose, jjtOpen, setScope

Methods inherited from class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode

children, getChild, getParent

Methods inherited from class net.sourceforge.pmd.lang.ast.AbstractNode

appendElement, findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, findDescendantsOfType, getAsDocument, getBeginColumn, getBeginLine, getDataFlowNode, getEndColumn, getEndLine, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfAnyType, getFirstParentOfType, getImage, getIndexInParent, getNthParent, getNumChildren, getParentsOfType, getUserData, getUserMap, getXPathAttributesIterator, hasDecendantOfAnyType, hasDescendantMatchingXPath, hasDescendantOfAnyType, hasDescendantOfType, hasImageEqualTo, isFindBoundary, isSingleLine, jjtAddChild, jjtGetChild, jjtGetChildIndex, jjtGetFirstToken, jjtGetId, jjtGetLastToken, jjtGetNumChildren, jjtGetParent, jjtSetChildIndex, jjtSetFirstToken, jjtSetLastToken, jjtSetParent, remove, removeChildAtIndex, setDataFlowNode, setImage, setUserData, testingOnlySetBeginColumn, testingOnlySetBeginLine, testingOnlySetEndColumn, testingOnlySetEndLine, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sourceforge.pmd.lang.java.ast.JavaNode

children, getChild, getParent

Methods inherited from interface net.sourceforge.pmd.lang.ast.Node

findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, findDescendantsOfType, getAsDocument, getBeginColumn, getBeginLine, getDataFlowNode, getEndColumn, getEndLine, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfAnyType, getFirstParentOfType, getImage, getIndexInParent, getNthParent, getNumChildren, getParentsOfType, getUserData, getUserMap, getXPathAttributesIterator, hasDescendantMatchingXPath, hasDescendantOfType, hasImageEqualTo, isFindBoundary, jjtAddChild, jjtGetChild, jjtGetChildIndex, jjtGetId, jjtGetNumChildren, jjtGetParent, jjtSetChildIndex, jjtSetParent, remove, removeChildAtIndex, setDataFlowNode, setImage, setUserData

Constructor Detail

ASTForStatement

@InternalApi
@Deprecated
public ASTForStatement(int id)

Deprecated.

ASTForStatement

@InternalApi
@Deprecated
public ASTForStatement(JavaParser p,
                       int id)

Deprecated.

Method Detail

jjtAccept

public Object jjtAccept(JavaParserVisitor visitor,
                        Object data)

Description copied from interface: JavaNode

Calls back the visitor's visit method corresponding to the runtime type of this Node.

Specified by:

jjtAccept in interface JavaNode

Overrides:

jjtAccept in class AbstractJavaNode

Parameters:

visitor - Visitor to dispatch

data - Visit data

getGuardExpressionNode

@Deprecated
public ASTExpression getGuardExpressionNode()

Deprecated.

Use getCondition()

Returns the node that represents the guard of this loop. This may be any expression of type boolean.

If this node represents a foreach loop, or if there is no specified guard, then returns null.

getCondition

public ASTExpression getCondition()

Returns the node that represents the guard of this loop. This may be any expression of type boolean.

If this node represents a foreach loop, or if there is no specified guard, then returns null.

isForeach

public boolean isForeach()

Returns true if this node represents a foreach loop.

getBody

public ASTStatement getBody()

Returns the statement that represents the body of this loop.