1 /*
2 * Copyright (c) 2005, 2019, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package javax.lang.model.util;
27
28
29 import java.util.List;
30 import javax.lang.model.element.*;
31
32 import javax.lang.model.type.TypeMirror;
33 import static javax.lang.model.SourceVersion.*;
34 import javax.lang.model.SourceVersion;
35 import javax.annotation.processing.SupportedSourceVersion;
36
37 /**
38 * A simple visitor for annotation values with default behavior
39 * appropriate for the {@link SourceVersion#RELEASE_6 RELEASE_6}
40 * source version. Visit methods call {@link
41 * #defaultAction} passing their arguments to {@code defaultAction}'s
42 * corresponding parameters.
43 *
44 * <p> Methods in this class may be overridden subject to their
45 * general contract. Note that annotating methods in concrete
46 * subclasses with {@link java.lang.Override @Override} will help
47 * ensure that methods are overridden as intended.
48 *
49 * <p> <b>WARNING:</b> The {@code AnnotationValueVisitor} interface
50 * implemented by this class may have methods added to it in the
51 * future to accommodate new, currently unknown, language structures
52 * added to future versions of the Java™ programming language.
53 * Therefore, methods whose names begin with {@code "visit"} may be
54 * added to this class in the future; to avoid incompatibilities,
55 * classes which extend this class should not declare any instance
56 * methods with names beginning with {@code "visit"}.
57 *
58 * <p>When such a new visit method is added, the default
59 * implementation in this class will be to call the {@link
60 * #visitUnknown visitUnknown} method. A new simple annotation
61 * value visitor class will also be introduced to correspond to the
62 * new language level; this visitor will have different default
63 * behavior for the visit method in question. When the new visitor is
64 * introduced, all or portions of this visitor may be deprecated.
65 *
66 * @param <R> the return type of this visitor's methods
67 * @param <P> the type of the additional parameter to this visitor's methods.
68 *
69 * @author Joseph D. Darcy
70 * @author Scott Seligman
71 * @author Peter von der Ahé
72 *
73 * @see SimpleAnnotationValueVisitor7
74 * @see SimpleAnnotationValueVisitor8
75 * @see SimpleAnnotationValueVisitor9
76 * @see SimpleAnnotationValueVisitor14
77 * @since 1.6
78 */
79 @SupportedSourceVersion(RELEASE_6)
80 public class SimpleAnnotationValueVisitor6<R, P>
81 extends AbstractAnnotationValueVisitor6<R, P> {
82
83 /**
84 * Default value to be returned; {@link #defaultAction
85 * defaultAction} returns this value unless the method is
86 * overridden.
87 */
88 protected final R DEFAULT_VALUE;
89
90 /**
91 * Constructor for concrete subclasses; uses {@code null} for the
92 * default value.
93 * @deprecated Release 6 is obsolete; update to a visitor for a newer
94 * release level.
95 */
96 @Deprecated(since="9")
97 protected SimpleAnnotationValueVisitor6() {
98 super();
99 DEFAULT_VALUE = null;
100 }
101
102 /**
103 * Constructor for concrete subclasses; uses the argument for the
104 * default value.
105 *
106 * @param defaultValue the value to assign to {@link #DEFAULT_VALUE}
107 * @deprecated Release 6 is obsolete; update to a visitor for a newer
108 * release level.
109 */
110 @Deprecated(since="9")
111 protected SimpleAnnotationValueVisitor6(R defaultValue) {
112 super();
113 DEFAULT_VALUE = defaultValue;
114 }
115
116 /**
117 * The default action for visit methods.
118 *
119 * @implSpec The implementation in this class just returns {@link
120 * #DEFAULT_VALUE}; subclasses will commonly override this method.
121 *
122 * @param o the value of the annotation
123 * @param p a visitor-specified parameter
124 * @return {@code DEFAULT_VALUE} unless overridden
125 */
126 protected R defaultAction(Object o, P p) {
127 return DEFAULT_VALUE;
128 }
129
130 /**
131 * {@inheritDoc}
132 *
133 * @implSpec This implementation calls {@code defaultAction}.
134 *
135 * @param b {@inheritDoc}
136 * @param p {@inheritDoc}
137 * @return the result of {@code defaultAction}
138 */
139 public R visitBoolean(boolean b, P p) {
140 return defaultAction(b, p);
141 }
142
143 /**
144 * {@inheritDoc}
145 *
146 * @implSpec This implementation calls {@code defaultAction}.
147 *
148 * @param b {@inheritDoc}
149 * @param p {@inheritDoc}
150 * @return the result of {@code defaultAction}
151 */
152 public R visitByte(byte b, P p) {
153 return defaultAction(b, p);
154 }
155
156 /**
157 * {@inheritDoc}
158 *
159 * @implSpec This implementation calls {@code defaultAction}.
160 *
161 * @param c {@inheritDoc}
162 * @param p {@inheritDoc}
163 * @return the result of {@code defaultAction}
164 */
165 public R visitChar(char c, P p) {
166 return defaultAction(c, p);
167 }
168
169 /**
170 * {@inheritDoc}
171 *
172 * @implSpec This implementation calls {@code defaultAction}.
173 *
174 *
175 * @param d {@inheritDoc}
176 * @param p {@inheritDoc}
177 * @return the result of {@code defaultAction}
178 */
179 public R visitDouble(double d, P p) {
180 return defaultAction(d, p);
181 }
182
183 /**
184 * {@inheritDoc}
185 *
186 * @implSpec This implementation calls {@code defaultAction}.
187 *
188 *
189 * @param f {@inheritDoc}
190 * @param p {@inheritDoc}
191 * @return the result of {@code defaultAction}
192 */
193 public R visitFloat(float f, P p) {
194 return defaultAction(f, p);
195 }
196
197 /**
198 * {@inheritDoc}
199 *
200 * @implSpec This implementation calls {@code defaultAction}.
201 *
202 * @param i {@inheritDoc}
203 * @param p {@inheritDoc}
204 * @return the result of {@code defaultAction}
205 */
206 public R visitInt(int i, P p) {
207 return defaultAction(i, p);
208 }
209
210 /**
211 * {@inheritDoc}
212 *
213 * @implSpec This implementation calls {@code defaultAction}.
214 *
215 * @param i {@inheritDoc}
216 * @param p {@inheritDoc}
217 * @return the result of {@code defaultAction}
218 */
219 public R visitLong(long i, P p) {
220 return defaultAction(i, p);
221 }
222
223 /**
224 * {@inheritDoc}
225 *
226 * @implSpec This implementation calls {@code defaultAction}.
227 *
228 * @param s {@inheritDoc}
229 * @param p {@inheritDoc}
230 * @return the result of {@code defaultAction}
231 */
232 public R visitShort(short s, P p) {
233 return defaultAction(s, p);
234 }
235
236 /**
237 * {@inheritDoc}
238 *
239 * @implSpec This implementation calls {@code defaultAction}.
240 *
241 * @param s {@inheritDoc}
242 * @param p {@inheritDoc}
243 * @return the result of {@code defaultAction}
244 */
245 public R visitString(String s, P p) {
246 return defaultAction(s, p);
247 }
248
249 /**
250 * {@inheritDoc}
251 *
252 * @implSpec This implementation calls {@code defaultAction}.
253 *
254 * @param t {@inheritDoc}
255 * @param p {@inheritDoc}
256 * @return the result of {@code defaultAction}
257 */
258 public R visitType(TypeMirror t, P p) {
259 return defaultAction(t, p);
260 }
261
262 /**
263 * {@inheritDoc}
264 *
265 * @implSpec This implementation calls {@code defaultAction}.
266 *
267 * @param c {@inheritDoc}
268 * @param p {@inheritDoc}
269 * @return the result of {@code defaultAction}
270 */
271 public R visitEnumConstant(VariableElement c, P p) {
272 return defaultAction(c, p);
273 }
274
275 /**
276 * {@inheritDoc}
277 *
278 * @implSpec This implementation calls {@code defaultAction}.
279 *
280 * @param a {@inheritDoc}
281 * @param p {@inheritDoc}
282 * @return the result of {@code defaultAction}
283 */
284 public R visitAnnotation(AnnotationMirror a, P p) {
285 return defaultAction(a, p);
286 }
287
288 /**
289 * {@inheritDoc}
290 *
291 * @implSpec This implementation calls {@code defaultAction}.
292 *
293 * @param vals {@inheritDoc}
294 * @param p {@inheritDoc}
295 * @return the result of {@code defaultAction}
296 */
297 public R visitArray(List<? extends AnnotationValue> vals, P p) {
298 return defaultAction(vals, p);
299 }
300 }