1 /*
2 * Copyright (c) 2005, 2017, 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 * @since 1.6
77 */
78 @SupportedSourceVersion(RELEASE_6)
79 public class SimpleAnnotationValueVisitor6<R, P>
80 extends AbstractAnnotationValueVisitor6<R, P> {
81
82 /**
83 * Default value to be returned; {@link #defaultAction
84 * defaultAction} returns this value unless the method is
85 * overridden.
86 */
87 protected final R DEFAULT_VALUE;
88
89 /**
90 * Constructor for concrete subclasses; uses {@code null} for the
91 * default value.
92 * @deprecated Release 6 is obsolete; update to a visitor for a newer
93 * release level.
94 */
95 @Deprecated(since="9")
96 protected SimpleAnnotationValueVisitor6() {
97 super();
98 DEFAULT_VALUE = null;
99 }
100
101 /**
102 * Constructor for concrete subclasses; uses the argument for the
103 * default value.
104 *
105 * @param defaultValue the value to assign to {@link #DEFAULT_VALUE}
106 * @deprecated Release 6 is obsolete; update to a visitor for a newer
107 * release level.
108 */
109 @Deprecated(since="9")
110 protected SimpleAnnotationValueVisitor6(R defaultValue) {
111 super();
112 DEFAULT_VALUE = defaultValue;
113 }
114
115 /**
116 * The default action for visit methods.
117 *
118 * @implSpec The implementation in this class just returns {@link
119 * #DEFAULT_VALUE}; subclasses will commonly override this method.
120 *
121 * @param o the value of the annotation
122 * @param p a visitor-specified parameter
123 * @return {@code DEFAULT_VALUE} unless overridden
124 */
125 protected R defaultAction(Object o, P p) {
126 return DEFAULT_VALUE;
127 }
128
129 /**
130 * {@inheritDoc}
131 *
132 * @implSpec This implementation calls {@code defaultAction}.
133 *
134 * @param b {@inheritDoc}
135 * @param p {@inheritDoc}
136 * @return the result of {@code defaultAction}
137 */
138 public R visitBoolean(boolean b, P p) {
139 return defaultAction(b, p);
140 }
141
142 /**
143 * {@inheritDoc}
144 *
145 * @implSpec This implementation calls {@code defaultAction}.
146 *
147 * @param b {@inheritDoc}
148 * @param p {@inheritDoc}
149 * @return the result of {@code defaultAction}
150 */
151 public R visitByte(byte b, P p) {
152 return defaultAction(b, p);
153 }
154
155 /**
156 * {@inheritDoc}
157 *
158 * @implSpec This implementation calls {@code defaultAction}.
159 *
160 * @param c {@inheritDoc}
161 * @param p {@inheritDoc}
162 * @return the result of {@code defaultAction}
163 */
164 public R visitChar(char c, P p) {
165 return defaultAction(c, p);
166 }
167
168 /**
169 * {@inheritDoc}
170 *
171 * @implSpec This implementation calls {@code defaultAction}.
172 *
173 *
174 * @param d {@inheritDoc}
175 * @param p {@inheritDoc}
176 * @return the result of {@code defaultAction}
177 */
178 public R visitDouble(double d, P p) {
179 return defaultAction(d, p);
180 }
181
182 /**
183 * {@inheritDoc}
184 *
185 * @implSpec This implementation calls {@code defaultAction}.
186 *
187 *
188 * @param f {@inheritDoc}
189 * @param p {@inheritDoc}
190 * @return the result of {@code defaultAction}
191 */
192 public R visitFloat(float f, P p) {
193 return defaultAction(f, p);
194 }
195
196 /**
197 * {@inheritDoc}
198 *
199 * @implSpec This implementation calls {@code defaultAction}.
200 *
201 * @param i {@inheritDoc}
202 * @param p {@inheritDoc}
203 * @return the result of {@code defaultAction}
204 */
205 public R visitInt(int i, P p) {
206 return defaultAction(i, p);
207 }
208
209 /**
210 * {@inheritDoc}
211 *
212 * @implSpec This implementation calls {@code defaultAction}.
213 *
214 * @param i {@inheritDoc}
215 * @param p {@inheritDoc}
216 * @return the result of {@code defaultAction}
217 */
218 public R visitLong(long i, P p) {
219 return defaultAction(i, p);
220 }
221
222 /**
223 * {@inheritDoc}
224 *
225 * @implSpec This implementation calls {@code defaultAction}.
226 *
227 * @param s {@inheritDoc}
228 * @param p {@inheritDoc}
229 * @return the result of {@code defaultAction}
230 */
231 public R visitShort(short s, P p) {
232 return defaultAction(s, p);
233 }
234
235 /**
236 * {@inheritDoc}
237 *
238 * @implSpec This implementation calls {@code defaultAction}.
239 *
240 * @param s {@inheritDoc}
241 * @param p {@inheritDoc}
242 * @return the result of {@code defaultAction}
243 */
244 public R visitString(String s, P p) {
245 return defaultAction(s, p);
246 }
247
248 /**
249 * {@inheritDoc}
250 *
251 * @implSpec This implementation calls {@code defaultAction}.
252 *
253 * @param t {@inheritDoc}
254 * @param p {@inheritDoc}
255 * @return the result of {@code defaultAction}
256 */
257 public R visitType(TypeMirror t, P p) {
258 return defaultAction(t, p);
259 }
260
261 /**
262 * {@inheritDoc}
263 *
264 * @implSpec This implementation calls {@code defaultAction}.
265 *
266 * @param c {@inheritDoc}
267 * @param p {@inheritDoc}
268 * @return the result of {@code defaultAction}
269 */
270 public R visitEnumConstant(VariableElement c, P p) {
271 return defaultAction(c, p);
272 }
273
274 /**
275 * {@inheritDoc}
276 *
277 * @implSpec This implementation calls {@code defaultAction}.
278 *
279 * @param a {@inheritDoc}
280 * @param p {@inheritDoc}
281 * @return the result of {@code defaultAction}
282 */
283 public R visitAnnotation(AnnotationMirror a, P p) {
284 return defaultAction(a, p);
285 }
286
287 /**
288 * {@inheritDoc}
289 *
290 * @implSpec This implementation calls {@code defaultAction}.
291 *
292 * @param vals {@inheritDoc}
293 * @param p {@inheritDoc}
294 * @return the result of {@code defaultAction}
295 */
296 public R visitArray(List<? extends AnnotationValue> vals, P p) {
297 return defaultAction(vals, p);
298 }
299 }