Initial upgrade to Platform/JDT 3.4.1
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / core / dom / InstanceofExpression.java
diff --git a/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/dom/InstanceofExpression.java b/net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/dom/InstanceofExpression.java
new file mode 100644 (file)
index 0000000..e629564
--- /dev/null
@@ -0,0 +1,263 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2008 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 net.sourceforge.phpdt.core.dom;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Instanceof expression AST node type.
+ * <pre>
+ * InstanceofExpression:
+ *    Expression <b>instanceof</b> Type
+ * </pre>
+ * 
+ * @since 2.0
+ * @noinstantiate This class is not intended to be instantiated by clients.
+ */
+public class InstanceofExpression extends Expression {
+
+       /**
+        * The "leftOperand" structural property of this node type.
+        * @since 3.0
+        */
+       public static final ChildPropertyDescriptor LEFT_OPERAND_PROPERTY = 
+               new ChildPropertyDescriptor(InstanceofExpression.class, "leftOperand", Expression.class, MANDATORY, CYCLE_RISK); //$NON-NLS-1$
+
+       /**
+        * The "rightOperand" structural property of this node type.
+        * @since 3.0
+        */
+       public static final ChildPropertyDescriptor RIGHT_OPERAND_PROPERTY = 
+               new ChildPropertyDescriptor(InstanceofExpression.class, "rightOperand", Type.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(3);
+               createPropertyList(InstanceofExpression.class, properyList);
+               addProperty(LEFT_OPERAND_PROPERTY, properyList);
+               addProperty(RIGHT_OPERAND_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})
+        * @since 3.0
+        */
+       public static List propertyDescriptors(int apiLevel) {
+               return PROPERTY_DESCRIPTORS;
+       }
+                       
+       /**
+        * The left operand; lazily initialized; defaults to an unspecified,
+        * but legal, simple name.
+        */
+       private Expression leftOperand = null;
+
+       /**
+        * The right operand; lazily initialized; defaults to an unspecified,
+        * but legal, simple type.
+        */
+       private Type rightOperand = null;
+
+       /**
+        * Creates a new AST node for an instanceof expression owned by the given 
+        * AST. By default, the node has unspecified (but legal) operator,
+        * left and right operands.
+        * 
+        * @param ast the AST that is to own this node
+        */
+       InstanceofExpression(AST ast) {
+               super(ast);
+       }
+
+       /* (omit javadoc for this method)
+        * Method declared on ASTNode.
+        */
+       final List internalStructuralPropertiesForType(int apiLevel) {
+               return propertyDescriptors(apiLevel);
+       }
+       
+       /* (omit javadoc for this method)
+        * Method declared on ASTNode.
+        */
+       final ASTNode internalGetSetChildProperty(ChildPropertyDescriptor property, boolean get, ASTNode child) {
+               if (property == LEFT_OPERAND_PROPERTY) {
+                       if (get) {
+                               return getLeftOperand();
+                       } else {
+                               setLeftOperand((Expression) child);
+                               return null;
+                       }
+               }
+               if (property == RIGHT_OPERAND_PROPERTY) {
+                       if (get) {
+                               return getRightOperand();
+                       } else {
+                               setRightOperand((Type) 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.
+        */
+       final int getNodeType0() {
+               return INSTANCEOF_EXPRESSION;
+       }
+
+       /* (omit javadoc for this method)
+        * Method declared on ASTNode.
+        */
+       ASTNode clone0(AST target) {
+               InstanceofExpression result = new InstanceofExpression(target);
+               result.setSourceRange(this.getStartPosition(), this.getLength());
+               result.setLeftOperand((Expression) getLeftOperand().clone(target));
+               result.setRightOperand((Type) getRightOperand().clone(target));
+               return result;
+       }
+
+       /* (omit javadoc for this method)
+        * Method declared on ASTNode.
+        */
+       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.
+        */
+       void accept0(ASTVisitor visitor) {
+               boolean visitChildren = visitor.visit(this);
+               if (visitChildren) {
+                       // visit children in normal left to right reading order
+                       acceptChild(visitor, getLeftOperand());
+                       acceptChild(visitor, getRightOperand());
+               }
+               visitor.endVisit(this);
+       }
+       
+       /**
+        * Returns the left operand of this instanceof expression.
+        * 
+        * @return the left operand node
+        */ 
+       public Expression getLeftOperand() {
+               if (this.leftOperand  == null) {
+                       // lazy init must be thread-safe for readers
+                       synchronized (this) {
+                               if (this.leftOperand == null) {
+                                       preLazyInit();
+                                       this.leftOperand= new SimpleName(this.ast);
+                                       postLazyInit(this.leftOperand, LEFT_OPERAND_PROPERTY);
+                               }
+                       }
+               }
+               return this.leftOperand;
+       }
+               
+       /**
+        * Sets the left operand of this instanceof expression.
+        * 
+        * @param expression the left operand 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 setLeftOperand(Expression expression) {
+               if (expression == null) {
+                       throw new IllegalArgumentException();
+               }
+               ASTNode oldChild = this.leftOperand;
+               preReplaceChild(oldChild, expression, LEFT_OPERAND_PROPERTY);
+               this.leftOperand = expression;
+               postReplaceChild(oldChild, expression, LEFT_OPERAND_PROPERTY);
+       }
+
+       /**
+        * Returns the right operand of this instanceof expression.
+        * 
+        * @return the right operand node
+        */ 
+       public Type getRightOperand() {
+               if (this.rightOperand  == null) {
+                       // lazy init must be thread-safe for readers
+                       synchronized (this) {
+                               if (this.rightOperand == null) {
+                                       preLazyInit();
+                                       this.rightOperand= new SimpleType(this.ast);
+                                       postLazyInit(this.rightOperand, RIGHT_OPERAND_PROPERTY);
+                               }
+                       }
+               }
+               return this.rightOperand;
+       }
+               
+       /**
+        * Sets the right operand of this instanceof expression.
+        * 
+        * @param referenceType the right operand 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 setRightOperand(Type referenceType) {
+               if (referenceType == null) {
+                       throw new IllegalArgumentException();
+               }
+               ASTNode oldChild = this.rightOperand;
+               preReplaceChild(oldChild, referenceType, RIGHT_OPERAND_PROPERTY);
+               this.rightOperand = referenceType;
+               postReplaceChild(oldChild, referenceType, RIGHT_OPERAND_PROPERTY);
+       }
+       
+       /* (omit javadoc for this method)
+        * Method declared on ASTNode.
+        */
+       int memSize() {
+               // treat Operator as free
+               return BASE_NODE_SIZE + 2 * 4;
+       }
+       
+       /* (omit javadoc for this method)
+        * Method declared on ASTNode.
+        */
+       int treeSize() {
+               return 
+                       memSize()
+                       + (this.leftOperand == null ? 0 : getLeftOperand().treeSize())
+                       + (this.rightOperand == null ? 0 : getRightOperand().treeSize());
+       }
+}