net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/core/dom/ChildListPropertyDescriptor.java

   1 /*******************************************************************************
   2  * Copyright (c) 2004, 2008 IBM Corporation and others.
   3  * All rights reserved. This program and the accompanying materials
   4  * are made available under the terms of the Eclipse Public License v1.0
   5  * which accompanies this distribution, and is available at
   6  * http://www.eclipse.org/legal/epl-v10.html
   7  *
   8  * Contributors:
   9  *     IBM Corporation - initial API and implementation
  10  *******************************************************************************/
  11 package net.sourceforge.phpdt.core.dom;
  12
  13 /**
  14  * Descriptor for a child list property of an AST node.
  15  * A child list property is one whose value is a list of
  16  * {@link ASTNode}.
  17  *
  18  * @see org.eclipse.jdt.core.dom.ASTNode#getStructuralProperty(StructuralPropertyDescriptor)
  19  * @since 3.0
  20  * @noinstantiate This class is not intended to be instantiated by clients.
  21  */
  22 public final class ChildListPropertyDescriptor extends StructuralPropertyDescriptor {
  23
  24         /**
  25          * Element type. For example, for a node type like
  26          * CompilationUnit, the "imports" property is ImportDeclaration.class.
  27          * <p>
  28          * Field is private, but marked package-visible for fast
  29          * access from ASTNode.
  30          * </p>
  31          */
  32         final Class elementType;
  33
  34         /**
  35          * Indicates whether a cycle is possible.
  36          * <p>
  37          * Field is private, but marked package-visible for fast
  38          * access from ASTNode.
  39          * </p>
  40          */
  41         final boolean cycleRisk;
  42
  43         /**
  44          * Creates a new child list property descriptor with the given property id.
  45          * Note that this constructor is declared package-private so that
  46          * property descriptors can only be created by the AST
  47          * implementation.
  48          *
  49          * @param nodeClass concrete AST node type that owns this property
  50          * @param propertyId the property id
  51          * @param elementType the element type of this property
  52          * @param cycleRisk <code>true</code> if this property is at
  53          * risk of cycles, and <code>false</code> if there is no worry about cycles
  54          */
  55         ChildListPropertyDescriptor(Class nodeClass, String propertyId, Class elementType, boolean cycleRisk) {
  56                 super(nodeClass, propertyId);
  57                 if (elementType == null) {
  58                         throw new IllegalArgumentException();
  59                 }
  60                 this.elementType = elementType;
  61                 this.cycleRisk = cycleRisk;
  62         }
  63
  64         /**
  65          * Returns the element type of this list property.
  66          * <p>
  67          * For example, for a node type like CompilationUnit,
  68          * the "imports" property returns <code>ImportDeclaration.class</code>.
  69          * </p>
  70          *
  71          * @return the element type of the property
  72          */
  73         public final Class getElementType() {
  74                 return this.elementType;
  75         }
  76
  77         /**
  78          * Returns whether this property is vulnerable to cycles.
  79          * <p>
  80          * A property is vulnerable to cycles if a node of the owning
  81          * type (that is, the type that owns this property) could legally
  82          * appear in the AST subtree below this property. For example,
  83          * the body property of a
  84          * {@link MethodDeclaration} node
  85          * admits a body which might include statement that embeds
  86          * another {@link MethodDeclaration} node.
  87          * On the other hand, the name property of a
  88          * MethodDeclaration node admits only names, and thereby excludes
  89          * another MethodDeclaration node.
  90          * </p>
  91          *
  92          * @return <code>true</code> if cycles are possible,
  93          * and <code>false</code> if cycles are impossible
  94          */
  95         public final boolean cycleRisk() {
  96                 return this.cycleRisk;
  97         }
  98 }