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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
/*******************************************************************************
* Copyright (c) 2010, 2012 Oracle. 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:
* Oracle - initial API and implementation
******************************************************************************/
package org.eclipse.jpt.common.core.internal.resource.java.source;
import java.util.Collections;
import java.util.List;
import org.eclipse.jdt.core.dom.ASTNode;
import org.eclipse.jdt.core.dom.CompilationUnit;
import org.eclipse.jdt.core.dom.Expression;
import org.eclipse.jpt.common.core.internal.utility.jdt.ASTTools;
import org.eclipse.jpt.common.core.internal.utility.jdt.AnnotatedElementAnnotationElementAdapter;
import org.eclipse.jpt.common.core.internal.utility.jdt.ConversionDeclarationAnnotationElementAdapter;
import org.eclipse.jpt.common.core.internal.utility.jdt.ElementAnnotationAdapter;
import org.eclipse.jpt.common.core.resource.java.Annotation;
import org.eclipse.jpt.common.core.resource.java.JavaResourceNode;
import org.eclipse.jpt.common.core.utility.TextRange;
import org.eclipse.jpt.common.core.utility.jdt.AnnotatedElement;
import org.eclipse.jpt.common.core.utility.jdt.AnnotationAdapter;
import org.eclipse.jpt.common.core.utility.jdt.AnnotationElementAdapter;
import org.eclipse.jpt.common.core.utility.jdt.DeclarationAnnotationAdapter;
import org.eclipse.jpt.common.core.utility.jdt.DeclarationAnnotationElementAdapter;
import org.eclipse.jpt.common.core.utility.jdt.IndexedAnnotationAdapter;
import org.eclipse.jpt.common.core.utility.jdt.IndexedDeclarationAnnotationElementAdapter;
/**
* some common state and behavior for Java source annotations;
* and lots of convenience methods
*/
public abstract class SourceAnnotation
extends SourceNode
implements Annotation
{
protected final AnnotatedElement annotatedElement;
protected final DeclarationAnnotationAdapter daa;
protected final AnnotationAdapter annotationAdapter;
protected TextRange annotationTextRange;
/**
* constructor for straight member annotation
*/
protected SourceAnnotation(JavaResourceNode parent, AnnotatedElement element, DeclarationAnnotationAdapter daa) {
this(parent, element, daa, new ElementAnnotationAdapter(element, daa));
}
/**
* constructor for nested annotation (typically)
*/
protected SourceAnnotation(JavaResourceNode parent, AnnotatedElement element, DeclarationAnnotationAdapter daa, AnnotationAdapter annotationAdapter) {
super(parent);
this.annotatedElement = element;
this.daa = daa;
this.annotationAdapter = annotationAdapter;
}
// ********** JavaResourceNode implementation **********
public TextRange getTextRange() {
return this.getAnnotationTextRange();
}
// ********** Annotation implementation **********
public void initialize(org.eclipse.jdt.core.dom.Annotation astAnnotation) {
this.annotationTextRange = this.buildTextRange(astAnnotation);
initialize((CompilationUnit) astAnnotation.getRoot());
}
public void synchronizeWith(org.eclipse.jdt.core.dom.Annotation astAnnotation) {
this.annotationTextRange = this.buildTextRange(astAnnotation);
synchronizeWith((CompilationUnit) astAnnotation.getRoot());
}
public void initialize(CompilationUnit astRoot) {
//use the more performant initialize(Annotation)
}
public void synchronizeWith(CompilationUnit astRoot) {
//use the more performant synchronizeWith(Annotation)
}
public org.eclipse.jdt.core.dom.Annotation getAstAnnotation(CompilationUnit astRoot) {
return this.annotationAdapter.getAnnotation(astRoot);
}
public void newAnnotation() {
this.initialize(this.annotationAdapter.newMarkerAnnotation());
}
public void removeAnnotation() {
this.annotationAdapter.removeAnnotation();
}
public boolean isUnset() {
return true;
}
// ********** convenience methods **********
protected DeclarationAnnotationElementAdapter<String> buildStringElementAdapter(String elementName) {
return ConversionDeclarationAnnotationElementAdapter.forStrings(this.daa, elementName);
}
protected DeclarationAnnotationElementAdapter<Boolean> buildBooleanElementAdapter(String elementName) {
return ConversionDeclarationAnnotationElementAdapter.forBooleans(this.daa, elementName);
}
protected DeclarationAnnotationElementAdapter<Integer> buildIntegerElementAdapter(String elementName) {
return ConversionDeclarationAnnotationElementAdapter.forNumbers(this.daa, elementName);
}
protected AnnotationElementAdapter<String> buildStringElementAdapter(DeclarationAnnotationElementAdapter<String> daea) {
return new AnnotatedElementAnnotationElementAdapter<String>(this.annotatedElement, daea);
}
protected AnnotationElementAdapter<Boolean> buildBooleanElementAdapter(DeclarationAnnotationElementAdapter<Boolean> daea) {
return new AnnotatedElementAnnotationElementAdapter<Boolean>(this.annotatedElement, daea);
}
protected AnnotationElementAdapter<Integer> buildIntegerElementAdapter(DeclarationAnnotationElementAdapter<Integer> daea) {
return new AnnotatedElementAnnotationElementAdapter<Integer>(this.annotatedElement, daea);
}
protected CompilationUnit buildASTRoot() {
return this.getJavaResourceCompilationUnit().buildASTRoot();
}
/**
* Return the text range corresponding to the annotation.
* If the annotation is missing, return <code>null</code>.
*/
protected TextRange getAnnotationTextRange() {
return this.annotationTextRange;
}
/**
* Return the text range corresponding to the annotation.
* If the annotation is missing, return <code>null</code>.
*/
protected TextRange getAnnotationTextRange(org.eclipse.jdt.core.dom.Annotation astAnnotation) {
return this.buildTextRange(astAnnotation);
}
/**
* Convenience method.
* Return the text range corresponding to the specified element.
* If the specified element is missing, return the annotation's text range instead.
*/
protected TextRange getElementTextRange(DeclarationAnnotationElementAdapter<?> elementAdapter, org.eclipse.jdt.core.dom.Annotation astAnnotation) {
return this.getElementTextRange(this.getAnnotationElementTextRange(elementAdapter, astAnnotation), astAnnotation);
}
/**
* Convenience method.
* Return the list of text ranges corresponding to the specified element.
* If the specified element is missing, return the annotation's text range instead.
*/
protected List<TextRange> getElementTextRanges(DeclarationAnnotationElementAdapter<?> elementAdapter, org.eclipse.jdt.core.dom.Annotation astAnnotation) {
return this.getElementTextRanges(this.getAnnotationElementTextRanges(elementAdapter, astAnnotation), astAnnotation);
}
/**
* Convenience method.
* Return the text range corresponding to the specified element at the given index.
* If the specified element is missing, return the annotation's text range instead.
*/
protected TextRange getElementTextRange(IndexedDeclarationAnnotationElementAdapter<?> elementAdapter, int index, org.eclipse.jdt.core.dom.Annotation astAnnotation) {
return this.getElementTextRange(this.getAnnotationElementTextRange(elementAdapter, index, astAnnotation), astAnnotation);
}
/**
* Convenience method. If the specified element text range is null
* return the member's text range instead.
*/
protected TextRange getElementTextRange(TextRange elementTextRange, org.eclipse.jdt.core.dom.Annotation astAnnotation) {
return (elementTextRange != null) ? elementTextRange : this.getAnnotationTextRange(astAnnotation);
}
/**
* Convenience method. If the specified element text range is null
* return the member's text range instead.
*/
protected List<TextRange> getElementTextRanges(List<TextRange> elementTextRanges, org.eclipse.jdt.core.dom.Annotation astAnnotation) {
return !elementTextRanges.isEmpty() ? elementTextRanges : Collections.singletonList(this.getAnnotationTextRange(astAnnotation));
}
/**
* Convenience method. Return whether the specified text range is not
* null (meaning the corresponding AST node exists) and the specified position touches it.
*/
protected boolean textRangeTouches(TextRange textRange, int pos) {
return (textRange != null) && textRange.touches(pos);
}
protected TextRange getAnnotationElementTextRange(DeclarationAnnotationElementAdapter<?> adapter, org.eclipse.jdt.core.dom.Annotation astAnnotation) {
return (astAnnotation == null) ? null : this.buildTextRange(this.getAnnotationElementExpression(adapter, astAnnotation));
}
protected List<TextRange> getAnnotationElementTextRanges(DeclarationAnnotationElementAdapter<?> adapter, org.eclipse.jdt.core.dom.Annotation astAnnotation) {
return (astAnnotation == null) ? Collections.<TextRange>emptyList() : this.buildTextRanges(this.getAnnotationElementExpression(adapter, astAnnotation));
}
protected TextRange getAnnotationElementTextRange(IndexedDeclarationAnnotationElementAdapter<?> adapter, int index, org.eclipse.jdt.core.dom.Annotation astAnnotation) {
return (astAnnotation == null) ? null : this.buildTextRange(this.getAnnotationElementExpression(adapter, index, astAnnotation));
}
/**
* Return the specified AST DOM element.
*/
protected Expression getAnnotationElementExpression(DeclarationAnnotationElementAdapter<?> adapter, org.eclipse.jdt.core.dom.Annotation astAnnotation) {
return adapter.getExpression(astAnnotation);
}
/**
* Return the specified AST DOM element.
*/
protected Expression getAnnotationElementExpression(IndexedDeclarationAnnotationElementAdapter<?> adapter, int index, org.eclipse.jdt.core.dom.Annotation astAnnotation) {
return adapter.selectExpression(astAnnotation, index);
}
/**
* Return the text range corresponding to the specified AST node.
* Return <code>null</code> if the AST node is <code>null</code>.
*/
protected TextRange buildTextRange(ASTNode astNode) {
return (astNode == null) ? null : ASTTools.buildTextRange(astNode);
}
/**
* Return the list of text ranges corresponding to the specified AST node.
* Return an empty list if the AST node is <code>null</code>.
*/
protected List<TextRange> buildTextRanges(ASTNode astNode) {
return (astNode == null) ? Collections.<TextRange>emptyList() : ASTTools.buildTextRanges(astNode);
}
// ********** NestableAnnotation implementation **********
/**
* Convenience implementation of method from {@link NestableAnnotation} interface
* for subclasses.
*/
public void moveAnnotation(int newIndex) {
this.getIndexedAnnotationAdapter().moveAnnotation(newIndex);
}
private IndexedAnnotationAdapter getIndexedAnnotationAdapter() {
return (IndexedAnnotationAdapter) this.annotationAdapter;
}
}
|
