+ * This kind of node collects several variable declaration fragments
+ * (VariableDeclarationFragment) into a single body declaration
+ * (BodyDeclaration), all sharing the same modifiers and base type.
+ *
+ * FieldDeclaration:
+ * [Javadoc] { ExtendedModifier } Type VariableDeclarationFragment
+ * { , VariableDeclarationFragment } ;
+ *
+ * + * When a Javadoc comment is present, the source range begins with the first + * character of the "/**" comment delimiter. When there is no Javadoc comment, + * the source range begins with the first character of the initial modifier or + * type. The source range extends through the last character of the final ";". + *
+ * + * @since 2.0 + * @noinstantiate This class is not intended to be instantiated by clients. + */ +public class FieldDeclaration extends BodyDeclaration { + + /** + * The "javadoc" structural property of this node type. + * @since 3.0 + */ + public static final ChildPropertyDescriptor JAVADOC_PROPERTY = + internalJavadocPropertyFactory(FieldDeclaration.class); + + /** + * The "modifiers" structural property of this node type (JLS2 API only). + * @since 3.0 + */ + public static final SimplePropertyDescriptor MODIFIERS_PROPERTY = + internalModifiersPropertyFactory(FieldDeclaration.class); + + /** + * The "modifiers" structural property of this node type (added in JLS3 API). + * @since 3.1 + */ + public static final ChildListPropertyDescriptor MODIFIERS2_PROPERTY = + internalModifiers2PropertyFactory(FieldDeclaration.class); + + /** + * The "type" structural property of this node type. + * @since 3.0 + */ + public static final ChildPropertyDescriptor TYPE_PROPERTY = + new ChildPropertyDescriptor(FieldDeclaration.class, "type", Type.class, MANDATORY, NO_CYCLE_RISK); //$NON-NLS-1$ + + /** + * The "fragments" structural property of this node type). + * @since 3.0 + */ + public static final ChildListPropertyDescriptor FRAGMENTS_PROPERTY = + new ChildListPropertyDescriptor(FieldDeclaration.class, "fragments", VariableDeclarationFragment.class, CYCLE_RISK); //$NON-NLS-1$ + + /** + * A list of property descriptors (element type: + * {@link StructuralPropertyDescriptor}), + * or null if uninitialized. + * @since 3.0 + */ + private static final List PROPERTY_DESCRIPTORS_2_0; + + /** + * A list of property descriptors (element type: + * {@link StructuralPropertyDescriptor}), + * or null if uninitialized. + * @since 3.1 + */ + private static final List PROPERTY_DESCRIPTORS_3_0; + + static { + List properyList = new ArrayList(5); + createPropertyList(FieldDeclaration.class, properyList); + addProperty(JAVADOC_PROPERTY, properyList); + addProperty(MODIFIERS_PROPERTY, properyList); + addProperty(TYPE_PROPERTY, properyList); + addProperty(FRAGMENTS_PROPERTY, properyList); + PROPERTY_DESCRIPTORS_2_0 = reapPropertyList(properyList); + + properyList = new ArrayList(5); + createPropertyList(FieldDeclaration.class, properyList); + addProperty(JAVADOC_PROPERTY, properyList); + addProperty(MODIFIERS2_PROPERTY, properyList); + addProperty(TYPE_PROPERTY, properyList); + addProperty(FRAGMENTS_PROPERTY, properyList); + PROPERTY_DESCRIPTORS_3_0 = 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 + *AST.JLS* constants
+
+ * @return a list of property descriptors (element type:
+ * {@link StructuralPropertyDescriptor})
+ * @since 3.0
+ */
+ public static List propertyDescriptors(int apiLevel) {
+ if (apiLevel == AST.JLS2_INTERNAL) {
+ return PROPERTY_DESCRIPTORS_2_0;
+ } else {
+ return PROPERTY_DESCRIPTORS_3_0;
+ }
+ }
+
+ /**
+ * The base type; lazily initialized; defaults to an unspecified,
+ * legal type.
+ */
+ private Type baseType = null;
+
+ /**
+ * The list of variable declaration fragments (element type:
+ * ). Defaults to an empty list.
+ */
+ private ASTNode.NodeList variableDeclarationFragments =
+ new ASTNode.NodeList(FRAGMENTS_PROPERTY);
+
+ /**
+ * Creates a new unparented field declaration statement node owned
+ * by the given AST. By default, the field declaration has: no modifiers,
+ * an unspecified (but legal) type, and an empty list of variable
+ * declaration fragments (which is syntactically illegal).
+ *
+ * N.B. This constructor is package-private.
+ *
+ *
+ * @param ast the AST that is to own this node
+ */
+ FieldDeclaration(AST ast) {
+ super(ast);
+ }
+
+ /* (omit javadoc for this method)
+ * Method declared on ASTNode.
+ * @since 3.0
+ */
+ final List internalStructuralPropertiesForType(int apiLevel) {
+ return propertyDescriptors(apiLevel);
+ }
+
+ /* (omit javadoc for this method)
+ * Method declared on ASTNode.
+ */
+ final int internalGetSetIntProperty(SimplePropertyDescriptor property, boolean get, int value) {
+ if (property == MODIFIERS_PROPERTY) {
+ if (get) {
+ return getModifiers();
+ } else {
+ internalSetModifiers(value);
+ return 0;
+ }
+ }
+ // allow default implementation to flag the error
+ return super.internalGetSetIntProperty(property, get, value);
+ }
+
+ /* (omit javadoc for this method)
+ * Method declared on ASTNode.
+ */
+ final ASTNode internalGetSetChildProperty(ChildPropertyDescriptor property, boolean get, ASTNode child) {
+ if (property == JAVADOC_PROPERTY) {
+ if (get) {
+ return getJavadoc();
+ } else {
+ setJavadoc((Javadoc) child);
+ return null;
+ }
+ }
+ if (property == TYPE_PROPERTY) {
+ if (get) {
+ return getType();
+ } else {
+ setType((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 List internalGetChildListProperty(ChildListPropertyDescriptor property) {
+ if (property == MODIFIERS2_PROPERTY) {
+ return modifiers();
+ }
+ if (property == FRAGMENTS_PROPERTY) {
+ return fragments();
+ }
+ // allow default implementation to flag the error
+ return super.internalGetChildListProperty(property);
+ }
+
+ /* (omit javadoc for this method)
+ * Method declared on BodyDeclaration.
+ */
+ final ChildPropertyDescriptor internalJavadocProperty() {
+ return JAVADOC_PROPERTY;
+ }
+
+ /* (omit javadoc for this method)
+ * Method declared on BodyDeclaration.
+ */
+ final SimplePropertyDescriptor internalModifiersProperty() {
+ return MODIFIERS_PROPERTY;
+ }
+
+ /* (omit javadoc for this method)
+ * Method declared on BodyDeclaration.
+ */
+ final ChildListPropertyDescriptor internalModifiers2Property() {
+ return MODIFIERS2_PROPERTY;
+ }
+
+ /* (omit javadoc for this method)
+ * Method declared on ASTNode.
+ */
+ final int getNodeType0() {
+ return FIELD_DECLARATION;
+ }
+
+ /* (omit javadoc for this method)
+ * Method declared on ASTNode.
+ */
+ ASTNode clone0(AST target) {
+ FieldDeclaration result = new FieldDeclaration(target);
+ result.setSourceRange(this.getStartPosition(), this.getLength());
+ result.setJavadoc(
+ (Javadoc) ASTNode.copySubtree(target, getJavadoc()));
+ if (this.ast.apiLevel == AST.JLS2_INTERNAL) {
+ result.internalSetModifiers(getModifiers());
+ }
+ if (this.ast.apiLevel >= AST.JLS3) {
+ result.modifiers().addAll(ASTNode.copySubtrees(target, modifiers()));
+ }
+ result.setType((Type) getType().clone(target));
+ result.fragments().addAll(
+ ASTNode.copySubtrees(target, fragments()));
+ 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, getJavadoc());
+ if (this.ast.apiLevel >= AST.JLS3) {
+ acceptChildren(visitor, this.modifiers);
+ }
+ acceptChild(visitor, getType());
+ acceptChildren(visitor, this.variableDeclarationFragments);
+ }
+ visitor.endVisit(this);
+ }
+
+ /**
+ * Returns the base type declared in this field declaration.
+ *
+ * N.B. The individual child variable declaration fragments may specify
+ * additional array dimensions. So the type of the variable are not
+ * necessarily exactly this type.
+ *
+ *
+ * @return the base type
+ */
+ public Type getType() {
+ if (this.baseType == null) {
+ // lazy init must be thread-safe for readers
+ synchronized (this) {
+ if (this.baseType == null) {
+ preLazyInit();
+ this.baseType = this.ast.newPrimitiveType(PrimitiveType.INT);
+ postLazyInit(this.baseType, TYPE_PROPERTY);
+ }
+ }
+ }
+ return this.baseType;
+ }
+
+ /**
+ * Sets the base type declared in this field declaration to the given type.
+ *
+ * @param type the new base type
+ * @exception IllegalArgumentException if:
+ *
+ * - the node belongs to a different AST
+ * - the node already has a parent
+ *
+ */
+ public void setType(Type type) {
+ if (type == null) {
+ throw new IllegalArgumentException();
+ }
+ ASTNode oldChild = this.baseType;
+ preReplaceChild(oldChild, type, TYPE_PROPERTY);
+ this.baseType = type;
+ postReplaceChild(oldChild, type, TYPE_PROPERTY);
+ }
+
+ /**
+ * Returns the live list of variable declaration fragments in this field
+ * declaration. Adding and removing nodes from this list affects this node
+ * dynamically. All nodes in this list must be
+ * VariableDeclarationFragments; attempts to add any other
+ * type of node will trigger an exception.
+ *
+ * @return the live list of variable declaration fragments in this
+ * statement (element type: VariableDeclarationFragment)
+ */
+ public List fragments() {
+ return this.variableDeclarationFragments;
+ }
+
+ /* (omit javadoc for this method)
+ * Method declared on ASTNode.
+ */
+ int memSize() {
+ return super.memSize() + 2 * 4;
+ }
+
+ /* (omit javadoc for this method)
+ * Method declared on ASTNode.
+ */
+ int treeSize() {
+ return
+ memSize()
+ + (this.optionalDocComment == null ? 0 : getJavadoc().treeSize())
+ + (this.modifiers == null ? 0 : this.modifiers.listSize())
+ + (this.baseType == null ? 0 : getType().treeSize())
+ + this.variableDeclarationFragments.listSize();
+ }
+}