1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
/*******************************************************************************
* 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.
* <pre>
* TextElement:
* Sequence of characters not including a close comment delimiter <b>*</b><b>/</b>
* </pre>
*
* @see Javadoc
* @since 3.0
* @noinstantiate This class is not intended to be instantiated by clients.
*/
@SuppressWarnings("rawtypes")
public final class TextElement extends ASTNode implements IDocElement {
/**
* The "text" structural property of this node type (type: {@link String}).
*
* @since 3.0
*/
public static final SimplePropertyDescriptor TEXT_PROPERTY =
new SimplePropertyDescriptor(TextElement.class, "text", String.class, MANDATORY); //$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;
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
* <code>AST.JLS*</code> constants
* @return a list of property descriptors (element type:
* {@link StructuralPropertyDescriptor})
* @since 3.0
*/
public static List propertyDescriptors(int apiLevel) {
return PROPERTY_DESCRIPTORS;
}
/**
* The text element; defaults to the empty string.
*/
private String text = Util.EMPTY_STRING;
/**
* Creates a new AST node for a text element owned by the given AST.
* The new node has an empty text string.
* <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
*/
TextElement(AST ast) {
super(ast);
}
@Override
final List internalStructuralPropertiesForType(int apiLevel) {
return propertyDescriptors(apiLevel);
}
@Override
final Object internalGetSetObjectProperty(SimplePropertyDescriptor property, boolean get, Object value) {
if (property == TEXT_PROPERTY) {
if (get) {
return getText();
} else {
setText((String) value);
return null;
}
}
// allow default implementation to flag the error
return super.internalGetSetObjectProperty(property, get, value);
}
@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);
}
/**
* Returns this node's text.
*
* @return the text of this node
*/
public String getText() {
return this.text;
}
/**
* Sets the text of this node to the given value.
* <p>
* 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 "*"+"/".
* </p>
*
* @param text the text of this node
* @exception IllegalArgumentException if the text is null
* or contains a block comment closing delimiter
*/
public void setText(String text) {
if (text == null) {
throw new IllegalArgumentException();
}
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();
}
}
|
