Wed, 06 Apr 2011 19:30:57 -0700
7033809: Rename "disjunctive" to "union" in javax.lang.model
Reviewed-by: mcimadamore, jjg
1 /*
2 * Copyright (c) 2010, 2011, 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 */
26 package javax.lang.model.util;
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.*;
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} and earlier
40 * language constructs call {@link #defaultAction defaultAction},
41 * passing their arguments to {@code defaultAction}'s corresponding
42 * 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 ElementVisitor} 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 element visitor
61 * class will also be introduced to correspond to the new language
62 * level; this visitor will have different default behavior for the
63 * visit method in question. When the new visitor is introduced, all
64 * or portions of this visitor may be deprecated.
65 *
66 * @param <R> the return type of this visitor's methods. Use {@code Void}
67 * for visitors that do not need to return results.
68 * @param <P> the type of the additional parameter to this visitor's methods. Use {@code Void}
69 * for visitors that do not need an additional parameter.
70 *
71 * @see SimpleElementVisitor6
72 * @since 1.7
73 */
74 @SupportedSourceVersion(RELEASE_7)
75 public class SimpleElementVisitor7<R, P> extends SimpleElementVisitor6<R, P> {
76 /**
77 * Constructor for concrete subclasses; uses {@code null} for the
78 * default value.
79 */
80 protected SimpleElementVisitor7(){
81 super(null);
82 }
84 /**
85 * Constructor for concrete subclasses; uses the argument for the
86 * default value.
87 *
88 * @param defaultValue the value to assign to {@link #DEFAULT_VALUE}
89 */
90 protected SimpleElementVisitor7(R defaultValue){
91 super(defaultValue);
92 }
94 /**
95 * This implementation calls {@code defaultAction}.
96 *
97 * @param e {@inheritDoc}
98 * @param p {@inheritDoc}
99 * @return the result of {@code defaultAction}
100 */
101 @Override
102 public R visitVariable(VariableElement e, P p) {
103 return defaultAction(e, p);
104 }
105 }