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 javax.lang.model.element.*;
29 import javax.annotation.processing.SupportedSourceVersion;
30 import static javax.lang.model.element.ElementKind.*;
31 import javax.lang.model.SourceVersion;
32 import static javax.lang.model.SourceVersion.*;
33
34 /**
35 * A simple visitor of program elements with default behavior
36 * appropriate for the {@link SourceVersion#RELEASE_7 RELEASE_7}
37 * source version.
38 *
39 * Visit methods corresponding to {@code RELEASE_7} language
40 * constructs call {@link #defaultAction}, passing their arguments to
41 * {@code defaultAction}'s corresponding parameters.
42 *
43 * <p> Methods in this class may be overridden subject to their
44 * general contract. Note that annotating methods in concrete
45 * subclasses with {@link java.lang.Override @Override} will help
46 * ensure that methods are overridden as intended.
47 *
48 * <p> <b>WARNING:</b> The {@code ElementVisitor} interface
49 * implemented by this class may have methods added to it in the
50 * future to accommodate new, currently unknown, language structures
51 * added to future versions of the Java™ programming language.
52 * Therefore, methods whose names begin with {@code "visit"} may be
53 * added to this class in the future; to avoid incompatibilities,
54 * classes which extend this class should not declare any instance
55 * methods with names beginning with {@code "visit"}.
56 *
57 * <p>When such a new visit method is added, the default
58 * implementation in this class will be to call the {@link
59 * #visitUnknown visitUnknown} method. A new simple element visitor
60 * class will also be introduced to correspond to the new language
61 * level; this visitor will have different default behavior for the
62 * visit method in question. When the new visitor is introduced, all
63 * or portions of this visitor may be deprecated.
64 *
65 * @param <R> the return type of this visitor's methods. Use {@code Void}
66 * for visitors that do not need to return results.
67 * @param <P> the type of the additional parameter to this visitor's methods. Use {@code Void}
68 * for visitors that do not need an additional parameter.
69 *
70 * @see SimpleElementVisitor6
71 * @since 1.7
72 */
73 @SupportedSourceVersion(RELEASE_7)
74 public class SimpleElementVisitor7<R, P> extends SharedSimpleElementVisitor<R, P> {
75 /**
76 * Constructor for concrete subclasses; uses {@code null} for the
77 * default value.
78 */
79 protected SimpleElementVisitor7(){
80 super();
81 }
82
83 /**
84 * Constructor for concrete subclasses; uses the argument for the
85 * default value.
86 *
87 * @param defaultValue the value to assign to {@link #DEFAULT_VALUE}
88 */
89 protected SimpleElementVisitor7(R defaultValue){
90 super(defaultValue);
91 }
92 }