org.eclipse.jdt.core.dom.ModuleQualifiedName Maven / Gradle / Ivy
The newest version!
/*******************************************************************************
* Copyright (c) 2020 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* 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 module qualified name. A module qualified name is defined as
* a qualified/simple name preceded by a module name, which qualifies it. Expressing it this
* way means that the module qualifier and the qualified name get their own AST nodes.
*
* ModuleQualifiedName:
* Name . Name
*
*
*
*
* @noinstantiate This class is not intended to be instantiated by clients.
* @since 3.24
*/
@SuppressWarnings("rawtypes")
public class ModuleQualifiedName extends Name {
/**
* The "qualifier" structural property of this node type (child type: {@link Name}). *
*/
public static final ChildPropertyDescriptor MODULE_QUALIFIER_PROPERTY =
new ChildPropertyDescriptor(ModuleQualifiedName.class, "moduleQualifier", SimpleName.class, MANDATORY, CYCLE_RISK); //$NON-NLS-1$
/**
* The "name" structural property of this node type (child type: {@link SimpleName}). *
*/
public static final ChildPropertyDescriptor NAME_PROPERTY =
new ChildPropertyDescriptor(ModuleQualifiedName.class, "name", QualifiedName.class, MANDATORY, 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 propertyList = new ArrayList(3);
createPropertyList(ModuleQualifiedName.class, propertyList);
addProperty(MODULE_QUALIFIER_PROPERTY, propertyList);
addProperty(NAME_PROPERTY, propertyList);
PROPERTY_DESCRIPTORS = reapPropertyList(propertyList);
}
/**
* 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})
*/
public static List propertyDescriptors(int apiLevel) {
return PROPERTY_DESCRIPTORS;
}
/**
* The identifier; lazily initialized; defaults to a unspecified, legal
* Java identifier.
*/
private Name moduleQualifier = null;
/**
* The name being module veysqualified; lazily initialized; defaults to a unspecified,
* legal Java identifier.
*/
private Name name = null;
/**
* Creates a new AST node for a module qualified name owned by the given AST.
*
* N.B. This constructor is package-private; all subclasses must be
* declared in the same package; clients are unable to declare
* additional subclasses.
*
*
* @param ast the AST that is to own this node
*/
ModuleQualifiedName(AST ast) {
super(ast);
unsupportedBelow15();
}
@Override
final List internalStructuralPropertiesForType(int apiLevel) {
return propertyDescriptors(apiLevel);
}
@Override
final ASTNode internalGetSetChildProperty(ChildPropertyDescriptor property, boolean get, ASTNode child) {
if (property == MODULE_QUALIFIER_PROPERTY) {
if (get) {
return getModuleQualifier();
} else {
setModuleQualifier((SimpleName) child);
return null;
}
}
if (property == NAME_PROPERTY) {
if (get) {
return getName();
} else {
setName((QualifiedName) child);
return null;
}
}
// allow default implementation to flag the error
return super.internalGetSetChildProperty(property, get, child);
}
@Override
final int getNodeType0() {
return MODULE_QUALIFIED_NAME;
}
@Override
ASTNode clone0(AST target) {
ModuleQualifiedName result = new ModuleQualifiedName(target);
result.setSourceRange(getStartPosition(), getLength());
result.setModuleQualifier((SimpleName) getModuleQualifier().clone(target));
result.setName((QualifiedName) getName().clone(target));
return result;
}
@Override
final boolean subtreeMatch0(ASTMatcher matcher, Object other) {
// dispatch to correct overloaded match method
return matcher.match(this, other);
}
@Override
void accept0(ASTVisitor visitor) {
boolean visitChildren = visitor.visit(this);
if (visitChildren) {
// visit children in normal left to right reading order
acceptChild(visitor, getModuleQualifier());
acceptChild(visitor, getName());
}
visitor.endVisit(this);
}
/**
* Returns the qualifier part of this qualified name.
*
* @return the qualifier part of this qualified name
*/
public Name getModuleQualifier() {
if (this.moduleQualifier == null) {
// lazy init must be thread-safe for readers
synchronized (this) {
if (this.moduleQualifier == null) {
preLazyInit();
this.moduleQualifier = new SimpleName(this.ast);
postLazyInit(this.moduleQualifier, MODULE_QUALIFIER_PROPERTY);
}
}
}
return this.moduleQualifier;
}
/**
* Sets the qualifier of this qualified name to the given name.
*
* @param moduleQualifier the qualifier of this qualified name
* @exception IllegalArgumentException if:
*
* - the node belongs to a different AST
* - the node already has a parent
* - a cycle in would be created
*
*/
public void setModuleQualifier(Name moduleQualifier) {
if (moduleQualifier == null) {
throw new IllegalArgumentException();
}
ASTNode oldChild = this.moduleQualifier;
preReplaceChild(oldChild, moduleQualifier, MODULE_QUALIFIER_PROPERTY);
this.moduleQualifier = moduleQualifier;
postReplaceChild(oldChild, moduleQualifier, MODULE_QUALIFIER_PROPERTY);
}
/**
* Returns the name part of this qualified name.
*
* @return the name being qualified
*/
public Name getName() {
return this.name;
}
/**
* Sets the name part of this qualified name to the given simple name.
*
* @param name the identifier of this qualified name
* @exception IllegalArgumentException if:
*
* - the node belongs to a different AST
* - the node already has a parent
*
*/
public void setName(Name name) {
ASTNode oldChild = this.name;
preReplaceChild(oldChild, name, NAME_PROPERTY);
this.name = name;
postReplaceChild(oldChild, name, NAME_PROPERTY);
}
@Override
void appendName(StringBuilder buffer) {
getModuleQualifier().appendName(buffer);
buffer.append('/');
if (getName() != null) {
getName().appendName(buffer);
}
}
@Override
int memSize() {
return BASE_NAME_NODE_SIZE + 3 * 4;
}
@Override
int treeSize() {
return
memSize()
+ (this.name == null ? 0 : getName().treeSize())
+ (this.moduleQualifier == null ? 0 : getModuleQualifier().treeSize());
}
}