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
|
/*
* Copyright (C) 2007-2010 Júlio Vilmar Gesser.
* Copyright (C) 2011, 2013-2016 The JavaParser Team.
*
* This file is part of JavaParser.
*
* JavaParser can be used either under the terms of
* a) the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* b) the terms of the Apache License
*
* You should have received a copy of both licenses in LICENCE.LGPL and
* LICENCE.APACHE. Please refer to those files for details.
*
* JavaParser is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*/
package com.github.javaparser.ast.nodeTypes;
import com.github.javaparser.ast.Node;
import com.github.javaparser.ast.NodeList;
import com.github.javaparser.ast.expr.*;
import java.lang.annotation.Annotation;
import java.util.Optional;
import static com.github.javaparser.JavaParser.parseExpression;
import static com.github.javaparser.JavaParser.parseName;
/**
* A node that can be annotated.
*
* @author Federico Tomassetti
* @since July 2014
*/
public interface NodeWithAnnotations<N extends Node> {
NodeList<AnnotationExpr> getAnnotations();
N setAnnotations(NodeList<AnnotationExpr> annotations);
void tryAddImportToParentCompilationUnit(Class<?> clazz);
default AnnotationExpr getAnnotation(int i) {
return getAnnotations().get(i);
}
@SuppressWarnings("unchecked")
default N setAnnotation(int i, AnnotationExpr element) {
getAnnotations().set(i, element);
return (N) this;
}
@SuppressWarnings("unchecked")
default N addAnnotation(AnnotationExpr element) {
getAnnotations().add(element);
return (N) this;
}
/**
* Annotates this
*
* @param name the name of the annotation
* @return this
*/
@SuppressWarnings("unchecked")
default N addAnnotation(String name) {
NormalAnnotationExpr annotation = new NormalAnnotationExpr(
parseName(name), new NodeList<>());
getAnnotations().add(annotation);
return (N) this;
}
/**
* Annotates this
*
* @param name the name of the annotation
* @return the {@link NormalAnnotationExpr} added
*/
@SuppressWarnings("unchecked")
default NormalAnnotationExpr addAndGetAnnotation(String name) {
NormalAnnotationExpr annotation = new NormalAnnotationExpr(
parseName(name), new NodeList<>());
getAnnotations().add(annotation);
return annotation;
}
/**
* Annotates this node and automatically add the import
*
* @param clazz the class of the annotation
* @return this
*/
default N addAnnotation(Class<? extends Annotation> clazz) {
tryAddImportToParentCompilationUnit(clazz);
return addAnnotation(clazz.getSimpleName());
}
/**
* Annotates this node and automatically add the import
*
* @param clazz the class of the annotation
* @return the {@link NormalAnnotationExpr} added
*/
default NormalAnnotationExpr addAndGetAnnotation(Class<? extends Annotation> clazz) {
tryAddImportToParentCompilationUnit(clazz);
return addAndGetAnnotation(clazz.getSimpleName());
}
/**
* Annotates this with a marker annotation
*
* @param name the name of the annotation
* @return this
*/
@SuppressWarnings("unchecked")
default N addMarkerAnnotation(String name) {
MarkerAnnotationExpr markerAnnotationExpr = new MarkerAnnotationExpr(
parseName(name));
getAnnotations().add(markerAnnotationExpr);
return (N) this;
}
/**
* Annotates this with a marker annotation and automatically add the import
*
* @param clazz the class of the annotation
* @return this
*/
default N addMarkerAnnotation(Class<? extends Annotation> clazz) {
tryAddImportToParentCompilationUnit(clazz);
return addMarkerAnnotation(clazz.getSimpleName());
}
/**
* Annotates this with a single member annotation
*
* @param name the name of the annotation
* @param expression the part between ()
* @return this
*/
@SuppressWarnings("unchecked")
default N addSingleMemberAnnotation(String name, Expression expression) {
SingleMemberAnnotationExpr singleMemberAnnotationExpr = new SingleMemberAnnotationExpr(
parseName(name), expression);
getAnnotations().add(singleMemberAnnotationExpr);
return (N) this;
}
/**
* Annotates this with a single member annotation
*
* @param name the name of the annotation
* @param value the value, don't forget to add \"\" for a string value
* @return this
*/
default N addSingleMemberAnnotation(String name, String value) {
return addSingleMemberAnnotation(name, parseExpression(value));
}
/**
* Annotates this with a single member annotation and automatically add the import
*
* @param clazz the class of the annotation
* @param value the value, don't forget to add \"\" for a string value
* @return this
*/
default N addSingleMemberAnnotation(Class<? extends Annotation> clazz,
String value) {
tryAddImportToParentCompilationUnit(clazz);
return addSingleMemberAnnotation(clazz.getSimpleName(), value);
}
/**
* Check whether an annotation with this name is present on this element
*
* @param annotationName the name of the annotation
* @return true if found, false if not
*/
default boolean isAnnotationPresent(String annotationName) {
return getAnnotations().stream().anyMatch(a -> a.getName().getIdentifier().equals(annotationName));
}
/**
* Check whether an annotation with this class is present on this element
*
* @param annotationClass the class of the annotation
* @return true if found, false if not
*/
default boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {
return isAnnotationPresent(annotationClass.getSimpleName());
}
/**
* Try to find an annotation by its name
*
* @param annotationName the name of the annotation
*/
default Optional<AnnotationExpr> getAnnotationByName(String annotationName) {
return getAnnotations().stream().filter(a -> a.getName().getIdentifier().equals(annotationName)).findFirst();
}
/**
* Try to find an annotation by its class
*
* @param annotationClass the class of the annotation
*/
default Optional<AnnotationExpr> getAnnotationByClass(Class<? extends Annotation> annotationClass) {
return getAnnotationByName(annotationClass.getSimpleName());
}
}
|
