Eclipse JDT Plug-in Developer Guide (Galileo) - ForStatement (Eclipse JDT API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse JDT
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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
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 Summary

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

static ChildPropertyDescriptor EXPRESSION_PROPERTY
          The "expression" structural property of this node type.

static ChildListPropertyDescriptor INITIALIZERS_PROPERTY
          The "initializers" structural property of this node type.

static ChildListPropertyDescriptor UPDATERS_PROPERTY
          The "updaters" structural property of this node type.

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

ANNOTATION_TYPE_DECLARATION, ANNOTATION_TYPE_MEMBER_DECLARATION, 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, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, DO_STATEMENT, EMPTY_STATEMENT, ENHANCED_FOR_STATEMENT, ENUM_CONSTANT_DECLARATION, ENUM_DECLARATION, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, JAVADOC, LABELED_STATEMENT, LINE_COMMENT, MALFORMED, MARKER_ANNOTATION, MEMBER_REF, MEMBER_VALUE_PAIR, METHOD_DECLARATION, METHOD_INVOCATION, METHOD_REF, METHOD_REF_PARAMETER, MODIFIER, NORMAL_ANNOTATION, NULL_LITERAL, NUMBER_LITERAL, ORIGINAL, PACKAGE_DECLARATION, PARAMETERIZED_TYPE, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, PROTECT, QUALIFIED_NAME, QUALIFIED_TYPE, RECOVERED, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_MEMBER_ANNOTATION, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SWITCH_CASE, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, TAG_ELEMENT, TEXT_ELEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, TYPE_PARAMETER, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT, WILDCARD_TYPE

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.

List initializers ()
          Returns the live ordered list of initializer expressions in this for statement.

static 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 setExpression ( Expression expression)
          Sets or clears the condition expression of this return statement.

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, 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

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

Field Detail

INITIALIZERS_PROPERTY

public static final 
ChildListPropertyDescriptor INITIALIZERS_PROPERTY

The "initializers" structural property of this node type.

Since:: 3.0

EXPRESSION_PROPERTY

public static final 
ChildPropertyDescriptor EXPRESSION_PROPERTY

The "expression" structural property of this node type.

Since:: 3.0

UPDATERS_PROPERTY

public static final 
ChildListPropertyDescriptor UPDATERS_PROPERTY

The "updaters" structural property of this node type.

Since:: 3.0

BODY_PROPERTY

public static final 
ChildPropertyDescriptor BODY_PROPERTY

The "body" structural property of this node type.

Since:: 3.0

Method Detail

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.