/*******************************************************************************
* Copyright (c) 2004, 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 org.eclipse.jdt.core.dom;
import java.util.ArrayList;
import java.util.List;
/**
* Annotation type declaration AST node type (added in JLS3 API).
*
* <pre>
* AnnotationTypeDeclaration:
* [ Javadoc ] { ExtendedModifier } <b>@</b> <b>interface</b> Identifier
* <b>{</b> { AnnotationTypeBodyDeclaration | <b>;</b> } <b>}</b>
* AnnotationTypeBodyDeclaration:
* AnnotationTypeMemberDeclaration
* FieldDeclaration
* TypeDeclaration
* EnumDeclaration
* AnnotationTypeDeclaration
* </pre>
* <p>
* The thing to note is that method declaration are replaced by annotation type member declarations
* in this context.
* </p>
* <p>
* 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 first modifier keyword (if modifiers), or the first character of the
* "@interface" (if no modifiers). The source range extends through the last character of the "}"
* token following the body declarations.
* </p>
*
* @since 3.1
* @noinstantiate This class is not intended to be instantiated by clients.
*/
public class AnnotationTypeDeclaration extends AbstractTypeDeclaration {
/**
* The "javadoc" structural property of this node type.
*/
public static final ChildPropertyDescriptor JAVADOC_PROPERTY=
internalJavadocPropertyFactory(AnnotationTypeDeclaration.class);
/**
* The "modifiers" structural property of this node type.
*/
public static final ChildListPropertyDescriptor MODIFIERS2_PROPERTY=
internalModifiers2PropertyFactory(AnnotationTypeDeclaration.class);
/**
* The "name" structural property of this node type.
*/
public static final ChildPropertyDescriptor NAME_PROPERTY=
internalNamePropertyFactory(AnnotationTypeDeclaration.class);
/**
* The "bodyDeclarations" structural property of this node type.
*/
public static final ChildListPropertyDescriptor BODY_DECLARATIONS_PROPERTY=
internalBodyDeclarationPropertyFactory(AnnotationTypeDeclaration.class);
/**
* 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(AnnotationTypeDeclaration.class, properyList);
addProperty(JAVADOC_PROPERTY, properyList);
addProperty(MODIFIERS2_PROPERTY, properyList);
addProperty(NAME_PROPERTY, properyList);
addProperty(BODY_DECLARATIONS_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;
}
/**
* Creates a new AST node for an annotation type declaration owned by the given AST. By default,
* the type declaration is for an annotation type of an unspecified, but legal, name; no
* modifiers; no javadoc; and an empty list of body declarations.
* <p>
* N.B. This constructor is package-private; all subclasses must be declared in the same
* package; clients are unable to declare additional subclasses.
* </p>
*
* @param ast the AST that is to own this node
*/
AnnotationTypeDeclaration(AST ast) {
super(ast);
unsupportedIn2();
}
/* (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 == JAVADOC_PROPERTY) {
if (get) {
return getJavadoc();
} else {
setJavadoc((Javadoc)child);
return null;
}
}
if (property == NAME_PROPERTY) {
if (get) {
return getName();
} else {
setName((SimpleName)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 == BODY_DECLARATIONS_PROPERTY) {
return bodyDeclarations();
}
// 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 ChildListPropertyDescriptor internalModifiers2Property() {
return MODIFIERS2_PROPERTY;
}
/* (omit javadoc for this method)
* Method declared on BodyDeclaration.
*/
final SimplePropertyDescriptor internalModifiersProperty() {
// this property will not be asked for (node type did not exist in JLS2)
return null;
}
/* (omit javadoc for this method)
* Method declared on AbstractTypeDeclaration.
*/
final ChildPropertyDescriptor internalNameProperty() {
return NAME_PROPERTY;
}
/* (omit javadoc for this method)
* Method declared on AbstractTypeDeclaration.
*/
final ChildListPropertyDescriptor internalBodyDeclarationsProperty() {
return BODY_DECLARATIONS_PROPERTY;
}
/* (omit javadoc for this method)
* Method declared on ASTNode.
*/
final int getNodeType0() {
return ANNOTATION_TYPE_DECLARATION;
}
/* (omit javadoc for this method)
* Method declared on ASTNode.
*/
ASTNode clone0(AST target) {
AnnotationTypeDeclaration result= new AnnotationTypeDeclaration(target);
result.setSourceRange(getStartPosition(), getLength());
result.setJavadoc(
(Javadoc)ASTNode.copySubtree(target, getJavadoc()));
result.modifiers().addAll(ASTNode.copySubtrees(target, modifiers()));
result.setName((SimpleName)getName().clone(target));
result.bodyDeclarations().addAll(ASTNode.copySubtrees(target, bodyDeclarations()));
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());
acceptChildren(visitor, this.modifiers);
acceptChild(visitor, getName());
acceptChildren(visitor, this.bodyDeclarations);
}
visitor.endVisit(this);
}
/* (omit javadoc for this method)
* Method declared on AsbtractTypeDeclaration.
*/
ITypeBinding internalResolveBinding() {
return this.ast.getBindingResolver().resolveType(this);
}
/* (omit javadoc for this method)
* Method declared on ASTNode.
*/
int memSize() {
return super.memSize();
}
/* (omit javadoc for this method)
* Method declared on ASTNode.
*/
int treeSize() {
return memSize()
+ (this.optionalDocComment == null ? 0 : getJavadoc().treeSize())
+ this.modifiers.listSize()
+ (this.typeName == null ? 0 : getName().treeSize())
+ this.bodyDeclarations.listSize();
}
}