/*******************************************************************************
* 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;
/**
* AST node for a method or constructor reference within a doc comment ({@link Javadoc}). The
* principal uses of these are in "@see" and "@link" tag elements, for references to method and
* constructor members.
*
* <pre>
* MethodRef:
* [ Name ] <b>#</b> Identifier
* <b>(</b> [ MethodRefParameter | { <b>,</b> MethodRefParameter } ] <b>)</b>
* </pre>
*
* @see Javadoc
* @since 3.0
* @noinstantiate This class is not intended to be instantiated by clients.
*/
public class MethodRef extends ASTNode implements IDocElement {
/**
* The "qualifier" structural property of this node type.
*
* @since 3.0
*/
public static final ChildPropertyDescriptor QUALIFIER_PROPERTY=
new ChildPropertyDescriptor(MethodRef.class, "qualifier", Name.class, OPTIONAL, NO_CYCLE_RISK); //$NON-NLS-1$
/**
* The "name" structural property of this node type.
*
* @since 3.0
*/
public static final ChildPropertyDescriptor NAME_PROPERTY=
new ChildPropertyDescriptor(MethodRef.class, "name", SimpleName.class, MANDATORY, NO_CYCLE_RISK); //$NON-NLS-1$
/**
* The "parameters" structural property of this node type.
*
* @since 3.0
*/
public static final ChildListPropertyDescriptor PARAMETERS_PROPERTY=
new ChildListPropertyDescriptor(MethodRef.class, "parameters", MethodRefParameter.class, NO_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(4);
createPropertyList(MethodRef.class, properyList);
addProperty(QUALIFIER_PROPERTY, properyList);
addProperty(NAME_PROPERTY, properyList);
addProperty(PARAMETERS_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 AST.JLS* constants
* @return a list of property descriptors (element type: {@link StructuralPropertyDescriptor})
* @since 3.0
*/
public static List propertyDescriptors(int apiLevel) {
return PROPERTY_DESCRIPTORS;
}
/**
* The optional qualifier; <code>null</code> for none; defaults to none.
*/
private Name optionalQualifier= null;
/**
* The method name; lazily initialized; defaults to a unspecified, legal Java method name.
*/
private SimpleName methodName= null;
/**
* The parameter declarations (element type: <code>MethodRefParameter</code>). Defaults to an
* empty list.
*/
private ASTNode.NodeList parameters=
new ASTNode.NodeList(PARAMETERS_PROPERTY);
/**
* Creates a new AST node for a method reference owned by the given AST. By default, the method
* reference is for a method with an unspecified, but legal, name; no qualifier; and an empty
* parameter list.
* <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
*/
MethodRef(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 == QUALIFIER_PROPERTY) {
if (get) {
return getQualifier();
} else {
setQualifier((Name)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 == PARAMETERS_PROPERTY) {
return parameters();
}
// allow default implementation to flag the error
return super.internalGetChildListProperty(property);
}
/* (omit javadoc for this method)
* Method declared on ASTNode.
*/
final int getNodeType0() {
return METHOD_REF;
}
/* (omit javadoc for this method)
* Method declared on ASTNode.
*/
ASTNode clone0(AST target) {
MethodRef result= new MethodRef(target);
result.setSourceRange(getStartPosition(), getLength());
result.setQualifier((Name)ASTNode.copySubtree(target, getQualifier()));
result.setName((SimpleName)ASTNode.copySubtree(target, getName()));
result.parameters().addAll(
ASTNode.copySubtrees(target, parameters()));
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, getQualifier());
acceptChild(visitor, getName());
acceptChildren(visitor, this.parameters);
}
visitor.endVisit(this);
}
/**
* Returns the qualifier of this method reference, or <code>null</code> if there is none.
*
* @return the qualifier name node, or <code>null</code> if there is none
*/
public Name getQualifier() {
return this.optionalQualifier;
}
/**
* Sets or clears the qualifier of this method reference.
*
* @param name the qualifier name 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>
* </ul>
*/
public void setQualifier(Name name) {
ASTNode oldChild= this.optionalQualifier;
preReplaceChild(oldChild, name, QUALIFIER_PROPERTY);
this.optionalQualifier= name;
postReplaceChild(oldChild, name, QUALIFIER_PROPERTY);
}
/**
* Returns the name of the referenced method or constructor.
*
* @return the method or constructor name node
*/
public SimpleName getName() {
if (this.methodName == null) {
// lazy init must be thread-safe for readers
synchronized (this) {
if (this.methodName == null) {
preLazyInit();
this.methodName= new SimpleName(this.ast);
postLazyInit(this.methodName, NAME_PROPERTY);
}
}
}
return this.methodName;
}
/**
* Sets the name of the referenced method or constructor to the given name.
*
* @param name the new method or constructor name node
* @exception IllegalArgumentException if:
* <ul>
* <li>the name is <code>null</code></li>
* <li>the node belongs to a different AST</li>
* <li>the node already has a parent</li>
* </ul>
*/
public void setName(SimpleName name) {
if (name == null) {
throw new IllegalArgumentException();
}
ASTNode oldChild= this.methodName;
preReplaceChild(oldChild, name, NAME_PROPERTY);
this.methodName= name;
postReplaceChild(oldChild, name, NAME_PROPERTY);
}
/**
* Returns the live ordered list of method parameter references for this method reference.
*
* @return the live list of method parameter references (element type:
* <code>MethodRefParameter</code>)
*/
public List parameters() {
return this.parameters;
}
/**
* Resolves and returns the binding for the entity referred to by this method reference.
* <p>
* Note that bindings are generally unavailable unless requested when the AST is being built.
* </p>
*
* @return the binding, or <code>null</code> if the binding cannot be resolved
*/
public final IBinding resolveBinding() {
return this.ast.getBindingResolver().resolveReference(this);
}
/* (omit javadoc for this method)
* Method declared on ASTNode.
*/
int memSize() {
return BASE_NODE_SIZE + 3 * 4;
}
/* (omit javadoc for this method)
* Method declared on ASTNode.
*/
int treeSize() {
return memSize()
+ (this.optionalQualifier == null ? 0 : getQualifier().treeSize())
+ (this.methodName == null ? 0 : getName().treeSize())
+ this.parameters.listSize();
}
}