org.eclipse.wst.jsdt.core.dom
Class ForInStatement

java.lang.Object
  extended by org.eclipse.wst.jsdt.core.dom.ASTNode
      extended by org.eclipse.wst.jsdt.core.dom.ProgramElement
          extended by org.eclipse.wst.jsdt.core.dom.Statement
              extended by org.eclipse.wst.jsdt.core.dom.ForInStatement

public class ForInStatement
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.

Provisional API: This class/interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.


Field Summary
static ChildPropertyDescriptor BODY_PROPERTY
          The "body" structural property of this node type.
static ChildPropertyDescriptor COLLECTION_PROPERTY
          The "expression" structural property of this node type.
static ChildPropertyDescriptor ITERATION_VARIABLE_PROPERTY
          The "initializers" structural property of this node type.
 
Fields inherited from class org.eclipse.wst.jsdt.core.dom.ASTNode
ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BLOCK_COMMENT, BOOLEAN_LITERAL, BREAK_STATEMENT, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, DO_STATEMENT, EMPTY_EXPRESSION, EMPTY_STATEMENT, ENHANCED_FOR_STATEMENT, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_IN_STATEMENT, FOR_STATEMENT, FUNCTION_DECLARATION, FUNCTION_EXPRESSION, FUNCTION_INVOCATION, FUNCTION_REF, FUNCTION_REF_PARAMETER, IF_STATEMENT, IMPORT_DECLARATION, INFERRED_TYPE, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, JAVASCRIPT_UNIT, JSDOC, LABELED_STATEMENT, LINE_COMMENT, LIST_EXPRESSION, MALFORMED, MEMBER_REF, MODIFIER, NULL_LITERAL, NUMBER_LITERAL, OBJECT_LITERAL, OBJECT_LITERAL_FIELD, ORIGINAL, PACKAGE_DECLARATION, PARAMETERIZED_TYPE, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, PROTECT, QUALIFIED_NAME, QUALIFIED_TYPE, RECOVERED, REGULAR_EXPRESSION_LITERAL, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SWITCH_CASE, SWITCH_STATEMENT, TAG_ELEMENT, TEXT_ELEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, TYPE_PARAMETER, UNDEFINED_LITERAL, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT, WILDCARD_TYPE, WITH_STATEMENT
 
Method Summary
 Statement getBody()
          Returns the body of this for statement.
 Expression getCollection()
          Returns the condition expression of this for statement, or null if there is none.
 Statement getIterationVariable()
           
static java.util.List propertyDescriptors(int apiLevel)
          Returns a list of structural property descriptors for this node type.
 void setBody(Statement statement)
          Sets the body of this for statement.
 void setCollection(Expression expression)
          Sets or clears the condition expression of this return statement.
 void setIterationVariable(Statement statement)
           
 
Methods inherited from class org.eclipse.wst.jsdt.core.dom.Statement
getLeadingComment, setLeadingComment
 
Methods inherited from class org.eclipse.wst.jsdt.core.dom.ASTNode
accept, copySubtree, copySubtrees, delete, equals, getAST, getFlags, getLength, getLocationInParent, getNodeType, getParent, getProperty, getRoot, getStartPosition, getStructuralProperty, hashCode, nodeClassForType, properties, setFlags, setProperty, setSourceRange, setStructuralProperty, structuralPropertiesForType, subtreeBytes, subtreeMatch, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ITERATION_VARIABLE_PROPERTY

public static final ChildPropertyDescriptor ITERATION_VARIABLE_PROPERTY
The "initializers" structural property of this node type.


COLLECTION_PROPERTY

public static final ChildPropertyDescriptor COLLECTION_PROPERTY
The "expression" structural property of this node type.


BODY_PROPERTY

public static final ChildPropertyDescriptor BODY_PROPERTY
The "body" structural property of this node type.

Method Detail

propertyDescriptors

public static java.util.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)

getCollection

public Expression getCollection()
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

getIterationVariable

public Statement getIterationVariable()

setCollection

public void setCollection(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:
java.lang.IllegalArgumentException - if:
  • the node belongs to a different AST
  • the node already has a parent
  • a cycle in would be created

setIterationVariable

public void setIterationVariable(Statement statement)

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 JavaScript 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:
java.lang.IllegalArgumentException - if:
  • the node belongs to a different AST
  • the node already has a parent
  • a cycle in would be created