1 /*
2 * Copyright (c) 2005, 2014, 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 * <p>Note that adding a default implementation of a new visit method
67 * in a visitor class will occur instead of adding a <em>default
68 * method</em> directly in the visitor interface since a Java SE 8
69 * language feature cannot be used to this version of the API since
70 * this version is required to be runnable on Java SE 7
71 * implementations. Future versions of the API that are only required
72 * to run on Java SE 8 and later may take advantage of default methods
73 * in this situation.
74 *
75 * @param <R> the return type of this visitor's methods
76 * @param <P> the type of the additional parameter to this visitor's methods.
77 *
78 * @author Joseph D. Darcy
79 * @author Scott Seligman
80 * @author Peter von der Ahé
81 *
82 * @see SimpleAnnotationValueVisitor7
83 * @see SimpleAnnotationValueVisitor8
84 * @see SimpleAnnotationValueVisitor9
85 * @since 1.6
86 * @deprecated Release 6 is obsolete; update to a visitor for a newer
87 * release level.
88 */
89 @Deprecated
90 @SupportedSourceVersion(RELEASE_6)
91 public class SimpleAnnotationValueVisitor6<R, P>
92 extends AbstractAnnotationValueVisitor6<R, P> {
93
94 /**
95 * Default value to be returned; {@link #defaultAction
96 * defaultAction} returns this value unless the method is
97 * overridden.
98 */
99 protected final R DEFAULT_VALUE;
100
101 /**
102 * Constructor for concrete subclasses; uses {@code null} for the
103 * default value.
104 */
105 protected SimpleAnnotationValueVisitor6() {
106 super();
107 DEFAULT_VALUE = null;
108 }
109
110 /**
111 * Constructor for concrete subclasses; uses the argument for the
112 * default value.
113 *
114 * @param defaultValue the value to assign to {@link #DEFAULT_VALUE}
115 */
116 protected SimpleAnnotationValueVisitor6(R defaultValue) {
117 super();
118 DEFAULT_VALUE = defaultValue;
119 }
120
121 /**
122 * The default action for visit methods. The implementation in
123 * this class just returns {@link #DEFAULT_VALUE}; subclasses will
124 * commonly override this method.
125 *
126 * @param o the value of the annotation
127 * @param p a visitor-specified parameter
128 * @return {@code DEFAULT_VALUE} unless overridden
129 */
130 protected R defaultAction(Object o, P p) {
131 return DEFAULT_VALUE;
132 }
133
134 /**
135 * {@inheritDoc} This implementation calls {@code defaultAction}.
136 *
137 * @param b {@inheritDoc}
138 * @param p {@inheritDoc}
139 * @return the result of {@code defaultAction}
140 */
141 public R visitBoolean(boolean b, P p) {
142 return defaultAction(b, p);
143 }
144
145 /**
146 * {@inheritDoc} 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} This implementation calls {@code defaultAction}.
158 *
159 * @param c {@inheritDoc}
160 * @param p {@inheritDoc}
161 * @return the result of {@code defaultAction}
162 */
163 public R visitChar(char c, P p) {
164 return defaultAction(c, p);
165 }
166
167 /**
168 * {@inheritDoc} This implementation calls {@code defaultAction}.
169 *
170 * @param d {@inheritDoc}
171 * @param p {@inheritDoc}
172 * @return the result of {@code defaultAction}
173 */
174 public R visitDouble(double d, P p) {
175 return defaultAction(d, p);
176 }
177
178 /**
179 * {@inheritDoc} This implementation calls {@code defaultAction}.
180 *
181 * @param f {@inheritDoc}
182 * @param p {@inheritDoc}
183 * @return the result of {@code defaultAction}
184 */
185 public R visitFloat(float f, P p) {
186 return defaultAction(f, p);
187 }
188
189 /**
190 * {@inheritDoc} This implementation calls {@code defaultAction}.
191 *
192 * @param i {@inheritDoc}
193 * @param p {@inheritDoc}
194 * @return the result of {@code defaultAction}
195 */
196 public R visitInt(int i, P p) {
197 return defaultAction(i, p);
198 }
199
200 /**
201 * {@inheritDoc} This implementation calls {@code defaultAction}.
202 *
203 * @param i {@inheritDoc}
204 * @param p {@inheritDoc}
205 * @return the result of {@code defaultAction}
206 */
207 public R visitLong(long i, P p) {
208 return defaultAction(i, p);
209 }
210
211 /**
212 * {@inheritDoc} This implementation calls {@code defaultAction}.
213 *
214 * @param s {@inheritDoc}
215 * @param p {@inheritDoc}
216 * @return the result of {@code defaultAction}
217 */
218 public R visitShort(short s, P p) {
219 return defaultAction(s, p);
220 }
221
222 /**
223 * {@inheritDoc} This implementation calls {@code defaultAction}.
224 *
225 * @param s {@inheritDoc}
226 * @param p {@inheritDoc}
227 * @return the result of {@code defaultAction}
228 */
229 public R visitString(String s, P p) {
230 return defaultAction(s, p);
231 }
232
233 /**
234 * {@inheritDoc} This implementation calls {@code defaultAction}.
235 *
236 * @param t {@inheritDoc}
237 * @param p {@inheritDoc}
238 * @return the result of {@code defaultAction}
239 */
240 public R visitType(TypeMirror t, P p) {
241 return defaultAction(t, p);
242 }
243
244 /**
245 * {@inheritDoc} This implementation calls {@code defaultAction}.
246 *
247 * @param c {@inheritDoc}
248 * @param p {@inheritDoc}
249 * @return the result of {@code defaultAction}
250 */
251 public R visitEnumConstant(VariableElement c, P p) {
252 return defaultAction(c, p);
253 }
254
255 /**
256 * {@inheritDoc} This implementation calls {@code defaultAction}.
257 *
258 * @param a {@inheritDoc}
259 * @param p {@inheritDoc}
260 * @return the result of {@code defaultAction}
261 */
262 public R visitAnnotation(AnnotationMirror a, P p) {
263 return defaultAction(a, p);
264 }
265
266 /**
267 * {@inheritDoc} This implementation calls {@code defaultAction}.
268 *
269 * @param vals {@inheritDoc}
270 * @param p {@inheritDoc}
271 * @return the result of {@code defaultAction}
272 */
273 public R visitArray(List<? extends AnnotationValue> vals, P p) {
274 return defaultAction(vals, p);
275 }
276 }