org.eclipse.jdt.core.dom
Class ForStatement

java.lang.Object
  |
  +--org.eclipse.jdt.core.dom.ASTNode
        |
        +--org.eclipse.jdt.core.dom.Statement
              |
              +--org.eclipse.jdt.core.dom.ForStatement

public class ForStatement

extends Statement

For statement AST node type.

 ForStatement:
    for (
 			[ ForInit ];
 			[ Expression ] ;
 			[ ForUpdate ] )
 			Statement
 ForInit:
 		( VariableDeclarationExpression
 			 | { Expression {, Expression } }
 ForUpdate:
 		Expression { , Expression }
 

Since:

2.0

Field Summary

Fields inherited from class org.eclipse.jdt.core.dom.ASTNode

ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BOOLEAN_LITERAL, BREAK_STATEMENT, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, DO_STATEMENT, EMPTY_STATEMENT, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, JAVADOC, LABELED_STATEMENT, MALFORMED, METHOD_DECLARATION, METHOD_INVOCATION, NULL_LITERAL, NUMBER_LITERAL, PACKAGE_DECLARATION, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, QUALIFIED_NAME, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SWITCH_CASE, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT

Method Summary

Statement	getBody() Returns the body of this for statement.
Expression	getExpression() Returns the condition expression of this for statement, or null if there is none.
int	getNodeType() Returns an integer value identifying the type of this concrete AST node.
List	initializers() Returns the live ordered list of initializer expressions in this for statement.
void	setBody(Statement statement) Sets the body of this for statement.
void	setExpression(Expression expression) Sets or clears the condition expression of this return statement.
boolean	subtreeMatch(ASTMatcher matcher, Object other) Returns whether the subtree rooted at the given node matches the given other object as decided by the given matcher.
List	updaters() Returns the live ordered list of update expressions in this for statement.

Methods inherited from class org.eclipse.jdt.core.dom.Statement

getLeadingComment, setLeadingComment

Methods inherited from class org.eclipse.jdt.core.dom.ASTNode

accept, copySubtree, copySubtrees, equals, getAST, getFlags, getLength, getParent, getProperty, getRoot, getStartPosition, properties, setFlags, setProperty, setSourceRange, subtreeBytes, toString

Methods inherited from class java.lang.Object

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

Method Detail

getNodeType

public int getNodeType()

Description copied from class: ASTNode

Returns an integer value identifying the type of this concrete AST node. The values are small positive integers, suitable for use in switch statements.

For each concrete node type there is a unique node type constant (name and value). The unique node type constant for a concrete node type such as CastExpression is ASTNode.CAST_EXPRESSION.

Specified by:

getNodeType in class ASTNode

Returns:

one of the node type constants

subtreeMatch

public boolean subtreeMatch(ASTMatcher matcher,
                            Object other)

Description copied from class: ASTNode

Returns whether the subtree rooted at the given node matches the given other object as decided by the given matcher.

Specified by:

subtreeMatch in class ASTNode

Parameters:

matcher - the matcher

other - the other object, or null

Returns:

true if the subtree matches, or false if they do not match

initializers

public List initializers()

Returns the live ordered list of initializer expressions in this for statement.

The list should consist of either a list of so called statement expressions (JLS2, 14.8), or a single VariableDeclarationExpression. Otherwise, the for statement would have no Java source equivalent.

Returns:

the live list of initializer expressions (element type: Expression)

getExpression

public Expression getExpression()

Returns the condition expression of this for statement, or null if there is none.

Returns:

the condition expression node, or null if there is none

setExpression

public void setExpression(Expression expression)

Sets or clears the condition expression of this return statement.

Parameters:

expression - the condition expression node, or null if there is none

Throws:

IllegalArgumentException - if:

• the node belongs to a different AST
• the node already has a parent
• a cycle in would be created

updaters

public List updaters()

Returns the live ordered list of update expressions in this for statement.

The list should consist of so called statement expressions. Otherwise, the for statement would have no Java source equivalent.

Returns:

the live list of update expressions (element type: Expression)

getBody

public Statement getBody()

Returns the body of this for statement.

Returns:

the body statement node

setBody

public void setBody(Statement statement)

Sets the body of this for statement.

Parameters:

statement - the body statement node

Throws:

IllegalArgumentException - if:

• the node belongs to a different AST
• the node already has a parent
• a cycle in would be created