Package 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:
                Expression { , Expression }
 ForUpdate:
                Expression { , Expression }

Note: When variables are declared in the initializer of a for statement such as "for (int a=1, b=2;;);", they should be represented as a single VariableDeclarationExpression with two fragments, rather than being split up into a pair of expressions.

Since:
2.0
Restriction:
This class is not intended to be instantiated by clients.

  • Field Details

    • INITIALIZERS_PROPERTY

      public static final ChildListPropertyDescriptor INITIALIZERS_PROPERTY
      The "initializers" structural property of this node type (element type: Expression).
      Since:
      3.0

    • EXPRESSION_PROPERTY

      public static final ChildPropertyDescriptor EXPRESSION_PROPERTY
      The "expression" structural property of this node type (child type: Expression).
      Since:
      3.0

    • UPDATERS_PROPERTY

      public static final ChildListPropertyDescriptor UPDATERS_PROPERTY
      The "updaters" structural property of this node type (element type: Expression).
      Since:
      3.0

    • BODY_PROPERTY

      public static final ChildPropertyDescriptor BODY_PROPERTY
      The "body" structural property of this node type (child type: Statement).
      Since:
      3.0

  • Method Details

    • propertyDescriptors

      public static List propertyDescriptors(int apiLevel)
      Returns a list of structural property descriptors for this node type. Clients must not modify the result.
      Parameters:
      apiLevel - the API level; one of the AST.JLS* constants
      Returns:
      a list of property descriptors (element type: StructuralPropertyDescriptor)
      Since:
      3.0

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

      Special note: The Java language does not allow a local variable declaration to appear as the body of a for statement (they may only appear within a block). However, the AST will allow a VariableDeclarationStatement as the body of a ForStatement. To get something that will compile, be sure to embed the VariableDeclarationStatement inside a Block.

      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