org.eclipse.jdt.core.dom.TextElement Maven / Gradle / Ivy
The newest version!
/*******************************************************************************
* Copyright (c) 2004, 2013 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;
import org.eclipse.jdt.internal.compiler.util.Util;
/**
* AST node for a text element within a doc comment.
*
* TextElement:
* Sequence of characters not including a close comment delimiter */
*
*
* @see Javadoc
* @since 3.0
* @noinstantiate This class is not intended to be instantiated by clients.
*/
@SuppressWarnings("rawtypes")
public final class TextElement extends AbstractTextElement {
/**
* The "text" structural property of this node type (type: {@link String}).
*/
public static final SimplePropertyDescriptor TEXT_PROPERTY =
internalTextPropertyFactory(TextElement.class);
/**
* A list of property descriptors (element type:
* {@link StructuralPropertyDescriptor}),
* or null if uninitialized.
* @since 3.0
*/
private static final List PROPERTY_DESCRIPTORS;
static {
List propertyList = new ArrayList(2);
createPropertyList(TextElement.class, propertyList);
addProperty(TEXT_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})
* @since 3.0
*/
public static List propertyDescriptors(int apiLevel) {
return PROPERTY_DESCRIPTORS;
}
@Override
final SimplePropertyDescriptor internalTextPropertyFactory() {
return TEXT_PROPERTY;
}
/**
* Creates a new AST node for a text element owned by the given AST.
* The new node has an empty text string.
*
* 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
*/
TextElement(AST ast) {
super(ast);
}
@Override
final List internalStructuralPropertiesForType(int apiLevel) {
return propertyDescriptors(apiLevel);
}
@Override
final int getNodeType0() {
return TEXT_ELEMENT;
}
@Override
ASTNode clone0(AST target) {
TextElement result = new TextElement(target);
result.setSourceRange(getStartPosition(), getLength());
result.setText(getText());
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) {
visitor.visit(this);
visitor.endVisit(this);
}
/**
* Sets the text of this node to the given value.
*
* The text element typically includes leading and trailing
* whitespace that separates it from the immediately preceding
* or following elements. The text element must not include
* a block comment closing delimiter "*"+"/".
*
*
* @param text the text of this node
* @exception IllegalArgumentException if the text is null
* or contains a block comment closing delimiter
*/
@Override
public void setText(String text) {
super.setText(text);
if (text.indexOf("*/") > 0) { //$NON-NLS-1$
throw new IllegalArgumentException();
}
preValueChange(TEXT_PROPERTY);
this.text = text;
postValueChange(TEXT_PROPERTY);
}
@Override
int memSize() {
int size = BASE_NODE_SIZE + 1 * 4;
if (this.text != Util.EMPTY_STRING) {
// everything but our empty string costs
size += stringSize(this.text);
}
return size;
}
@Override
int treeSize() {
return memSize();
}
}