1 /*
2 * Copyright 2010 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.lang.model.util;
27
28 import java.util.List;
29 import javax.lang.model.element.*;
30
31 import javax.lang.model.type.TypeMirror;
32 import static javax.lang.model.SourceVersion.*;
33 import javax.lang.model.SourceVersion;
34 import javax.annotation.processing.SupportedSourceVersion;
35
36 /**
37 * A skeletal visitor for annotation values with default behavior
38 * appropriate for the {@link SourceVersion#RELEASE_7 RELEASE_7}
39 * source version.
40 *
41 * <p> <b>WARNING:</b> The {@code AnnotationValueVisitor} interface
42 * implemented by this class may have methods added to it in the
43 * future to accommodate new, currently unknown, language structures
44 * added to future versions of the Java™ programming language.
45 * Therefore, methods whose names begin with {@code "visit"} may be
46 * added to this class in the future; to avoid incompatibilities,
47 * classes which extend this class should not declare any instance
48 * methods with names beginning with {@code "visit"}.
49 *
50 * <p>When such a new visit method is added, the default
51 * implementation in this class will be to call the {@link
52 * #visitUnknown visitUnknown} method. A new abstract annotation
53 * value visitor class will also be introduced to correspond to the
54 * new language level; this visitor will have different default
55 * behavior for the visit method in question. When the new visitor is
56 * introduced, all or portions of this visitor may be deprecated.
57 *
58 * @param <R> the return type of this visitor's methods
59 * @param <P> the type of the additional parameter to this visitor's methods.
60 *
61 * @see AbstractAnnotationValueVisitor6
62 * @since 1.7
63 */
64 @SupportedSourceVersion(RELEASE_7)
65 public abstract class AbstractAnnotationValueVisitor7<R, P>
66 implements AnnotationValueVisitor<R, P> {
67
68 /**
69 * Constructor for concrete subclasses to call.
70 */
71 protected AbstractAnnotationValueVisitor7() {}
72
73 /**
74 * Visits an annotation value as if by passing itself to that
75 * value's {@link AnnotationValue#accept accept}. The invocation
76 * {@code v.visit(av)} is equivalent to {@code av.accept(v, p)}.
77 * @param av {@inheritDoc}
78 * @param p {@inheritDoc}
79 */
80 public final R visit(AnnotationValue av, P p) {
81 return av.accept(this, p);
82 }
83
84 /**
85 * Visits an annotation value as if by passing itself to that
86 * value's {@link AnnotationValue#accept accept} method passing
87 * {@code null} for the additional parameter. The invocation
88 * {@code v.visit(av)} is equivalent to {@code av.accept(v,
89 * null)}.
90 * @param av {@inheritDoc}
91 */
92 public final R visit(AnnotationValue av) {
93 return av.accept(this, null);
94 }
95
96 /**
97 * {@inheritDoc}
98 *
99 * <p>The default implementation of this method in {@code
100 * AbstractAnnotationValueVisitor7} will always throw {@code
101 * UnknownAnnotationValueException}. This behavior is not
102 * required of a subclass.
103 *
104 * @param av {@inheritDoc}
105 * @param p {@inheritDoc}
106 */
107 public R visitUnknown(AnnotationValue av, P p) {
108 throw new UnknownAnnotationValueException(av, p);
109 }
110 }