SimpleAnnotationValueVisitor6.java revision 3884:b6960e2da008 
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
26package javax.lang.model.util;
27
28
29import java.util.List;
30import javax.lang.model.element.*;
31
32import javax.lang.model.type.TypeMirror;
33import static javax.lang.model.SourceVersion.*;
34import javax.lang.model.SourceVersion;
35import 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&trade; 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&eacute;
72 *
73 * @see SimpleAnnotationValueVisitor7
74 * @see SimpleAnnotationValueVisitor8
75 * @see SimpleAnnotationValueVisitor9
76 * @since 1.6
77 * @deprecated Release 6 is obsolete; update to a visitor for a newer
78 * release level.
79 */
80@Deprecated
81@SupportedSourceVersion(RELEASE_6)
82public class SimpleAnnotationValueVisitor6<R, P>
83    extends AbstractAnnotationValueVisitor6<R, P> {
84
85    /**
86     * Default value to be returned; {@link #defaultAction
87     * defaultAction} returns this value unless the method is
88     * overridden.
89     */
90    protected final R DEFAULT_VALUE;
91
92    /**
93     * Constructor for concrete subclasses; uses {@code null} for the
94     * default value.
95     */
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     */
107    protected SimpleAnnotationValueVisitor6(R defaultValue) {
108        super();
109        DEFAULT_VALUE = defaultValue;
110    }
111
112    /**
113     * The default action for visit methods.  The implementation in
114     * this class just returns {@link #DEFAULT_VALUE}; subclasses will
115     * commonly override this method.
116     *
117     * @param o the value of the annotation
118     * @param p a visitor-specified parameter
119     * @return {@code DEFAULT_VALUE} unless overridden
120     */
121    protected R defaultAction(Object o, P p) {
122        return DEFAULT_VALUE;
123    }
124
125    /**
126     * {@inheritDoc} This implementation calls {@code defaultAction}.
127     *
128     * @param b {@inheritDoc}
129     * @param p {@inheritDoc}
130     * @return  the result of {@code defaultAction}
131     */
132    public R visitBoolean(boolean b, P p) {
133        return defaultAction(b, p);
134    }
135
136    /**
137     * {@inheritDoc} This implementation calls {@code defaultAction}.
138     *
139     * @param b {@inheritDoc}
140     * @param p {@inheritDoc}
141     * @return  the result of {@code defaultAction}
142     */
143    public R visitByte(byte b, P p) {
144        return defaultAction(b, p);
145    }
146
147    /**
148     * {@inheritDoc} This implementation calls {@code defaultAction}.
149     *
150     * @param c {@inheritDoc}
151     * @param p {@inheritDoc}
152     * @return  the result of {@code defaultAction}
153     */
154    public R visitChar(char c, P p) {
155        return defaultAction(c, p);
156    }
157
158    /**
159     * {@inheritDoc} This implementation calls {@code defaultAction}.
160     *
161     * @param d {@inheritDoc}
162     * @param p {@inheritDoc}
163     * @return  the result of {@code defaultAction}
164     */
165    public R visitDouble(double d, P p) {
166        return defaultAction(d, p);
167    }
168
169    /**
170     * {@inheritDoc} This implementation calls {@code defaultAction}.
171     *
172     * @param f {@inheritDoc}
173     * @param p {@inheritDoc}
174     * @return  the result of {@code defaultAction}
175     */
176    public R visitFloat(float f, P p) {
177        return defaultAction(f, p);
178    }
179
180    /**
181     * {@inheritDoc} This implementation calls {@code defaultAction}.
182     *
183     * @param i {@inheritDoc}
184     * @param p {@inheritDoc}
185     * @return  the result of {@code defaultAction}
186     */
187    public R visitInt(int i, P p) {
188        return defaultAction(i, p);
189    }
190
191    /**
192     * {@inheritDoc} This implementation calls {@code defaultAction}.
193     *
194     * @param i {@inheritDoc}
195     * @param p {@inheritDoc}
196     * @return  the result of {@code defaultAction}
197     */
198    public R visitLong(long i, P p) {
199        return defaultAction(i, p);
200    }
201
202    /**
203     * {@inheritDoc} This implementation calls {@code defaultAction}.
204     *
205     * @param s {@inheritDoc}
206     * @param p {@inheritDoc}
207     * @return  the result of {@code defaultAction}
208     */
209    public R visitShort(short s, P p) {
210        return defaultAction(s, p);
211    }
212
213    /**
214     * {@inheritDoc} This implementation calls {@code defaultAction}.
215     *
216     * @param s {@inheritDoc}
217     * @param p {@inheritDoc}
218     * @return  the result of {@code defaultAction}
219     */
220    public R visitString(String s, P p) {
221        return defaultAction(s, p);
222    }
223
224    /**
225     * {@inheritDoc} This implementation calls {@code defaultAction}.
226     *
227     * @param t {@inheritDoc}
228     * @param p {@inheritDoc}
229     * @return  the result of {@code defaultAction}
230     */
231    public R visitType(TypeMirror t, P p) {
232        return defaultAction(t, p);
233    }
234
235    /**
236     * {@inheritDoc} This implementation calls {@code defaultAction}.
237     *
238     * @param c {@inheritDoc}
239     * @param p {@inheritDoc}
240     * @return  the result of {@code defaultAction}
241     */
242    public R visitEnumConstant(VariableElement c, P p) {
243        return defaultAction(c, p);
244    }
245
246    /**
247     * {@inheritDoc} This implementation calls {@code defaultAction}.
248     *
249     * @param a {@inheritDoc}
250     * @param p {@inheritDoc}
251     * @return  the result of {@code defaultAction}
252     */
253    public R visitAnnotation(AnnotationMirror a, P p) {
254        return defaultAction(a, p);
255    }
256
257    /**
258     * {@inheritDoc} This implementation calls {@code defaultAction}.
259     *
260     * @param vals {@inheritDoc}
261     * @param p {@inheritDoc}
262     * @return  the result of {@code defaultAction}
263     */
264    public R visitArray(List<? extends AnnotationValue> vals, P p) {
265        return defaultAction(vals, p);
266    }
267}
268