bundles/org.eclipse.wst.jsdt.core/src/org/eclipse/wst/jsdt/core/dom/ForOfStatement.java - jsdt/webtools.jsdt - Git at Google

 /*******************************************************************************
  * Copyright (c) 2000, 2016 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *     IBM Corporation - initial API and implementation
  *******************************************************************************/

 package org.eclipse.wst.jsdt.core.dom;

 import java.util.ArrayList;
 import java.util.List;


 /**
  * For...of statement AST node type.
  *
  * <pre>
  * for (variable of object) {
  *    statement
  * }
  * </pre>
  * <p>
  * Note: When variables are declared in the initializer of a for statement
  * such as "<code>for (var i of collection);</code>", they should be
  * represented as a single <code>VariableDeclarationStatement</code>
  * </p>
  *
  * 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.
  *
  * @since 2.0
  */
 public class ForOfStatement extends Statement {

 	/**
 	 * The "iteration variable" structural property of this node type.
 	 *
 	 */
 	public static final ChildPropertyDescriptor ITERATION_VARIABLE_PROPERTY =
 		new ChildPropertyDescriptor(ForOfStatement.class, "iterationVariable", Expression.class, MANDATORY, CYCLE_RISK); //$NON-NLS-1$

 	/**
 	 * The "expression" structural property of this node type.
 	 *
 	 */
 	public static final ChildPropertyDescriptor COLLECTION_PROPERTY =
 		new ChildPropertyDescriptor(ForOfStatement.class, "collection", Expression.class, MANDATORY, CYCLE_RISK); //$NON-NLS-1$


 	/**
 	 * The "body" structural property of this node type.
 	 *
 	 */
 	public static final ChildPropertyDescriptor BODY_PROPERTY =
 		new ChildPropertyDescriptor(ForOfStatement.class, "body", Statement.class, MANDATORY, CYCLE_RISK); //$NON-NLS-1$

 	/**
 	 * A list of property descriptors (element type:
 	 * {@link StructuralPropertyDescriptor}),
 	 * or null if uninitialized.
 	 */
 	private static final List PROPERTY_DESCRIPTORS;

 	static {
 		List properyList = new ArrayList(5);
 		createPropertyList(ForOfStatement.class, properyList);
 		addProperty(ITERATION_VARIABLE_PROPERTY, properyList);
 		addProperty(COLLECTION_PROPERTY, properyList);
 		addProperty(BODY_PROPERTY, properyList);
 		PROPERTY_DESCRIPTORS = reapPropertyList(properyList);
 	}

 	/**
 	 * Returns a list of structural property descriptors for this node type.
 	 * Clients must not modify the result.
 	 *
 	 * @param apiLevel the API level; one of the
 	 * <code>AST.JLS*</code> constants

 	 * @return a list of property descriptors (element type:
 	 * {@link StructuralPropertyDescriptor})
 	 *
 	 */
 	public static List propertyDescriptors(int apiLevel) {
 		return PROPERTY_DESCRIPTORS;
 	}

 	private Expression iterationVariable  = null;

 	private Expression collection = null;


 	/**
 	 * The body statement; lazily initialized; defaults to an empty block
 	 * statement.
 	 */
 	private Statement body = null;

 	/**
 	 * Creates a new AST node for a for statement owned by the given AST.
 	 * By default, there are no initializers, no condition expression,
 	 * no updaters, and the body is an empty block.
 	 *
 	 * @param ast the AST that is to own this node
 	 */
 	ForOfStatement(AST ast) {
 		super(ast);
 	}

 	/* (omit javadoc for this method)
 	 * Method declared on ASTNode.
 	 */
 	@Override
 	final List internalStructuralPropertiesForType(int apiLevel) {
 		return propertyDescriptors(apiLevel);
 	}


 	/* (omit javadoc for this method)
 	 * Method declared on ASTNode.
 	 */
 	@Override
 	final ASTNode internalGetSetChildProperty(ChildPropertyDescriptor property, boolean get, ASTNode child) {
 		if (property == ITERATION_VARIABLE_PROPERTY) {
 			if (get) {
 				return getIterationVariable();
 			} else {
 				setIterationVariable((Expression) child);
 				return null;
 			}
 		}
 		if (property == COLLECTION_PROPERTY) {
 			if (get) {
 				return getCollection();
 			} else {
 				setCollection((Expression) child);
 				return null;
 			}
 		}
 		if (property == BODY_PROPERTY) {
 			if (get) {
 				return getBody();
 			} else {
 				setBody((Statement) child);
 				return null;
 			}
 		}
 		// allow default implementation to flag the error
 		return super.internalGetSetChildProperty(property, get, child);
 	}

 	/* (omit javadoc for this method)
 	 * Method declared on ASTNode.
 	 */
 	@Override
 	final int getNodeType0() {
 		return FOR_OF_STATEMENT;
 	}

 	/* (omit javadoc for this method)
 	 * Method declared on ASTNode.
 	 */
 	@Override
 	ASTNode clone0(AST target) {
 		ForOfStatement result = new ForOfStatement(target);
 		result.setSourceRange(this.getStartPosition(), this.getLength());
 		result.copyLeadingComment(this);
 		result.setIterationVariable(
 				(Expression) ASTNode.copySubtree(target, getIterationVariable()));
 		result.setCollection(
 				(Expression) ASTNode.copySubtree(target, getCollection()));
 		result.setBody(
 			(Statement) ASTNode.copySubtree(target, getBody()));
 		return result;
 	}

 	/* (omit javadoc for this method)
 	 * Method declared on ASTNode.
 	 */
 	@Override
 	final boolean subtreeMatch0(ASTMatcher matcher, Object other) {
 		// dispatch to correct overloaded match method
 		return matcher.match(this, other);
 	}

 	/* (omit javadoc for this method)
 	 * Method declared on ASTNode.
 	 */
 	@Override
 	void accept0(ASTVisitor visitor) {
 		boolean visitChildren = visitor.visit(this);
 		if (visitChildren) {
 			// visit children in normal left to right reading order
 			acceptChild(visitor, this.iterationVariable);
 			acceptChild(visitor, getCollection());
 			acceptChild(visitor, getBody());
 		}
 		visitor.endVisit(this);
 	}


 	/**
 	 * Returns the condition expression of this for statement, or
 	 * <code>null</code> if there is none.
 	 *
 	 * @return the condition expression node, or <code>null</code> if
 	 *     there is none
 	 */
 	public Expression getCollection() {
 		return this.collection;
 	}

 	public Expression getIterationVariable() {
 		return this.iterationVariable;
 	}

 	/**
 	 * Sets or clears the condition expression of this return statement.
 	 *
 	 * @param expression the condition expression node, or <code>null</code>
 	 *    if there is none
 	 * @exception IllegalArgumentException if:
 	 * <ul>
 	 * <li>the node belongs to a different AST</li>
 	 * <li>the node already has a parent</li>
 	 * <li>a cycle in would be created</li>
 	 * </ul>
 	 */
 	public void setCollection(Expression expression) {
 		ASTNode oldChild = this.collection;
 		preReplaceChild(oldChild, expression, COLLECTION_PROPERTY);
 		this.collection = expression;
 		postReplaceChild(oldChild, expression, COLLECTION_PROPERTY);
 	}

 	public void setIterationVariable(Expression expression) {
 		ASTNode oldChild = this.iterationVariable;
 		preReplaceChild(oldChild, expression, ITERATION_VARIABLE_PROPERTY);
 		this.iterationVariable = expression;
 		postReplaceChild(oldChild, expression, ITERATION_VARIABLE_PROPERTY);
 	}


 	/**
 	 * Returns the body of this for statement.
 	 *
 	 * @return the body statement node
 	 */
 	public Statement getBody() {
 		if (this.body == null) {
 			// lazy init must be thread-safe for readers
 			synchronized (this) {
 				if (this.body == null) {
 					preLazyInit();
 					this.body = new Block(this.ast);
 					postLazyInit(this.body, BODY_PROPERTY);
 				}
 			}
 		}
 		return this.body;
 	}

 	/**
 	 * Sets the body of this for statement.
 	 * <p>
 	 * 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 <code>VariableDeclarationStatement</code>
 	 * as the body of a <code>ForStatement</code>. To get something that will
 	 * compile, be sure to embed the <code>VariableDeclarationStatement</code>
 	 * inside a <code>Block</code>.
 	 * </p>
 	 *
 	 * @param statement the body statement node
 	 * @exception IllegalArgumentException if:
 	 * <ul>
 	 * <li>the node belongs to a different AST</li>
 	 * <li>the node already has a parent</li>
 	 * <li>a cycle in would be created</li>
 	 * </ul>
 	 */
 	public void setBody(Statement statement) {
 		if (statement == null) {
 			throw new IllegalArgumentException();
 		}
 		ASTNode oldChild = this.body;
 		preReplaceChild(oldChild, statement, BODY_PROPERTY);
 		this.body = statement;
 		postReplaceChild(oldChild, statement, BODY_PROPERTY);
 	}

 	/* (omit javadoc for this method)
 	 * Method declared on ASTNode.
 	 */
 	@Override
 	int memSize() {
 		return super.memSize() + 4 * 4;
 	}

 	/* (omit javadoc for this method)
 	 * Method declared on ASTNode.
 	 */
 	@Override
 	int treeSize() {
 		return
 			memSize()
 			+ getIterationVariable().treeSize()
 			+  getCollection().treeSize()
 			+ (this.body == null ? 0 : getBody().treeSize());
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2000, 2016 IBM Corporation and others.
	* All rights reserved. This program and the accompanying materials
	* are made available under the terms of the Eclipse Public License v1.0
	* which accompanies this distribution, and is available at
	* http://www.eclipse.org/legal/epl-v10.html
	*
	* Contributors:
	* IBM Corporation - initial API and implementation
	*******************************************************************************/

	package org.eclipse.wst.jsdt.core.dom;

	import java.util.ArrayList;
	import java.util.List;


	/**
	* For...of statement AST node type.
	*
	* <pre>
	* for (variable of object) {
	* statement
	* }
	* </pre>
	* <p>
	* Note: When variables are declared in the initializer of a for statement
	* such as "<code>for (var i of collection);</code>", they should be
	* represented as a single <code>VariableDeclarationStatement</code>
	* </p>
	*
	* 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.
	*
	* @since 2.0
	*/
	public class ForOfStatement extends Statement {

	/**
	* The "iteration variable" structural property of this node type.
	*
	*/
	public static final ChildPropertyDescriptor ITERATION_VARIABLE_PROPERTY =
	new ChildPropertyDescriptor(ForOfStatement.class, "iterationVariable", Expression.class, MANDATORY, CYCLE_RISK); //$NON-NLS-1$

	/**
	* The "expression" structural property of this node type.
	*
	*/
	public static final ChildPropertyDescriptor COLLECTION_PROPERTY =
	new ChildPropertyDescriptor(ForOfStatement.class, "collection", Expression.class, MANDATORY, CYCLE_RISK); //$NON-NLS-1$


	/**
	* The "body" structural property of this node type.
	*
	*/
	public static final ChildPropertyDescriptor BODY_PROPERTY =
	new ChildPropertyDescriptor(ForOfStatement.class, "body", Statement.class, MANDATORY, CYCLE_RISK); //$NON-NLS-1$

	/**
	* A list of property descriptors (element type:
	* {@link StructuralPropertyDescriptor}),
	* or null if uninitialized.
	*/
	private static final List PROPERTY_DESCRIPTORS;

	static {
	List properyList = new ArrayList(5);
	createPropertyList(ForOfStatement.class, properyList);
	addProperty(ITERATION_VARIABLE_PROPERTY, properyList);
	addProperty(COLLECTION_PROPERTY, properyList);
	addProperty(BODY_PROPERTY, properyList);
	PROPERTY_DESCRIPTORS = reapPropertyList(properyList);
	}

	/**
	* Returns a list of structural property descriptors for this node type.
	* Clients must not modify the result.
	*
	* @param apiLevel the API level; one of the
	* <code>AST.JLS*</code> constants

	* @return a list of property descriptors (element type:
	* {@link StructuralPropertyDescriptor})
	*
	*/
	public static List propertyDescriptors(int apiLevel) {
	return PROPERTY_DESCRIPTORS;
	}

	private Expression iterationVariable = null;

	private Expression collection = null;


	/**
	* The body statement; lazily initialized; defaults to an empty block
	* statement.
	*/
	private Statement body = null;

	/**
	* Creates a new AST node for a for statement owned by the given AST.
	* By default, there are no initializers, no condition expression,
	* no updaters, and the body is an empty block.
	*
	* @param ast the AST that is to own this node
	*/
	ForOfStatement(AST ast) {
	super(ast);
	}

	/* (omit javadoc for this method)
	* Method declared on ASTNode.
	*/
	@Override
	final List internalStructuralPropertiesForType(int apiLevel) {
	return propertyDescriptors(apiLevel);
	}


	/* (omit javadoc for this method)
	* Method declared on ASTNode.
	*/
	@Override
	final ASTNode internalGetSetChildProperty(ChildPropertyDescriptor property, boolean get, ASTNode child) {
	if (property == ITERATION_VARIABLE_PROPERTY) {
	if (get) {
	return getIterationVariable();
	} else {
	setIterationVariable((Expression) child);
	return null;
	}
	}
	if (property == COLLECTION_PROPERTY) {
	if (get) {
	return getCollection();
	} else {
	setCollection((Expression) child);
	return null;
	}
	}
	if (property == BODY_PROPERTY) {
	if (get) {
	return getBody();
	} else {
	setBody((Statement) child);
	return null;
	}
	}
	// allow default implementation to flag the error
	return super.internalGetSetChildProperty(property, get, child);
	}

	/* (omit javadoc for this method)
	* Method declared on ASTNode.
	*/
	@Override
	final int getNodeType0() {
	return FOR_OF_STATEMENT;
	}

	/* (omit javadoc for this method)
	* Method declared on ASTNode.
	*/
	@Override
	ASTNode clone0(AST target) {
	ForOfStatement result = new ForOfStatement(target);
	result.setSourceRange(this.getStartPosition(), this.getLength());
	result.copyLeadingComment(this);
	result.setIterationVariable(
	(Expression) ASTNode.copySubtree(target, getIterationVariable()));
	result.setCollection(
	(Expression) ASTNode.copySubtree(target, getCollection()));
	result.setBody(
	(Statement) ASTNode.copySubtree(target, getBody()));
	return result;
	}

	/* (omit javadoc for this method)
	* Method declared on ASTNode.
	*/
	@Override
	final boolean subtreeMatch0(ASTMatcher matcher, Object other) {
	// dispatch to correct overloaded match method
	return matcher.match(this, other);
	}

	/* (omit javadoc for this method)
	* Method declared on ASTNode.
	*/
	@Override
	void accept0(ASTVisitor visitor) {
	boolean visitChildren = visitor.visit(this);
	if (visitChildren) {
	// visit children in normal left to right reading order
	acceptChild(visitor, this.iterationVariable);
	acceptChild(visitor, getCollection());
	acceptChild(visitor, getBody());
	}
	visitor.endVisit(this);
	}


	/**
	* Returns the condition expression of this for statement, or
	* <code>null</code> if there is none.
	*
	* @return the condition expression node, or <code>null</code> if
	* there is none
	*/
	public Expression getCollection() {
	return this.collection;
	}

	public Expression getIterationVariable() {
	return this.iterationVariable;
	}

	/**
	* Sets or clears the condition expression of this return statement.
	*
	* @param expression the condition expression node, or <code>null</code>
	* if there is none
	* @exception IllegalArgumentException if:
	* <ul>
	* <li>the node belongs to a different AST</li>
	* <li>the node already has a parent</li>
	* <li>a cycle in would be created</li>
	* </ul>
	*/
	public void setCollection(Expression expression) {
	ASTNode oldChild = this.collection;
	preReplaceChild(oldChild, expression, COLLECTION_PROPERTY);
	this.collection = expression;
	postReplaceChild(oldChild, expression, COLLECTION_PROPERTY);
	}

	public void setIterationVariable(Expression expression) {
	ASTNode oldChild = this.iterationVariable;
	preReplaceChild(oldChild, expression, ITERATION_VARIABLE_PROPERTY);
	this.iterationVariable = expression;
	postReplaceChild(oldChild, expression, ITERATION_VARIABLE_PROPERTY);
	}


	/**
	* Returns the body of this for statement.
	*
	* @return the body statement node
	*/
	public Statement getBody() {
	if (this.body == null) {
	// lazy init must be thread-safe for readers
	synchronized (this) {
	if (this.body == null) {
	preLazyInit();
	this.body = new Block(this.ast);
	postLazyInit(this.body, BODY_PROPERTY);
	}
	}
	}
	return this.body;
	}

	/**
	* Sets the body of this for statement.
	* <p>
	* 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 <code>VariableDeclarationStatement</code>
	* as the body of a <code>ForStatement</code>. To get something that will
	* compile, be sure to embed the <code>VariableDeclarationStatement</code>
	* inside a <code>Block</code>.
	* </p>
	*
	* @param statement the body statement node
	* @exception IllegalArgumentException if:
	* <ul>
	* <li>the node belongs to a different AST</li>
	* <li>the node already has a parent</li>
	* <li>a cycle in would be created</li>
	* </ul>
	*/
	public void setBody(Statement statement) {
	if (statement == null) {
	throw new IllegalArgumentException();
	}
	ASTNode oldChild = this.body;
	preReplaceChild(oldChild, statement, BODY_PROPERTY);
	this.body = statement;
	postReplaceChild(oldChild, statement, BODY_PROPERTY);
	}

	/* (omit javadoc for this method)
	* Method declared on ASTNode.
	*/
	@Override
	int memSize() {
	return super.memSize() + 4 * 4;
	}

	/* (omit javadoc for this method)
	* Method declared on ASTNode.
	*/
	@Override
	int treeSize() {
	return
	memSize()
	+ getIterationVariable().treeSize()
	+ getCollection().treeSize()
	+ (this.body == null ? 0 : getBody().treeSize());
	}
	}