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

Class ASTForStatement

java.lang.Object

net.sourceforge.pmd.lang.ast.AbstractNode

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)
ASTForStatement(JavaParser p, int id)

Method Summary

Modifier and Type	Method	Description
ASTStatement	getBody()	Returns the statement that represents the body of this loop.
ASTExpression	getGuardExpressionNode()	Returns the node that represents the guard of this loop.
boolean	isForeach()	Returns true if this node represents a foreach loop.
java.lang.Object	jjtAccept(JavaParserVisitor visitor, java.lang.Object data)	Accept the visitor

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.AbstractNode

appendElement, findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, findDescendantsOfType, getAsDocument, getBeginColumn, getBeginLine, getDataFlowNode, getEndColumn, getEndLine, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfAnyType, getFirstParentOfType, getImage, getNthParent, getParentsOfType, getUserData, 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.ast.Node

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

Constructor Detail

ASTForStatement

public ASTForStatement(int id)

ASTForStatement

public ASTForStatement(JavaParser p,
                       int id)

Method Detail

jjtAccept

public java.lang.Object jjtAccept(JavaParserVisitor visitor,
                                  java.lang.Object data)

Description copied from class: AbstractJavaNode

Accept the visitor. *

Specified by:

jjtAccept in interface JavaNode

Overrides:

jjtAccept in class AbstractJavaNode

getGuardExpressionNode

public ASTExpression getGuardExpressionNode()

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.