1 /*
2 * Copyright (c) 2005, 2019, 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
26 package javax.lang.model.util;
27
28 import javax.lang.model.element.*;
29 import javax.annotation.processing.SupportedSourceVersion;
30 import javax.lang.model.SourceVersion;
31 import static javax.lang.model.SourceVersion.*;
32
33
34 /**
35 * A simple visitor of program elements with default behavior
36 * appropriate for the {@link SourceVersion#RELEASE_6 RELEASE_6}
37 * source version.
38 *
39 * Visit methods corresponding to {@code RELEASE_6} language
40 * constructs call {@link #defaultAction defaultAction}, passing their
41 * arguments to {@code defaultAction}'s corresponding parameters.
42 *
43 * For constructs introduced in {@code RELEASE_7} and later, {@code
44 * visitUnknown} is called instead.
45 *
46 * <p> Methods in this class may be overridden subject to their
47 * general contract. Note that annotating methods in concrete
48 * subclasses with {@link java.lang.Override @Override} will help
49 * ensure that methods are overridden as intended.
50 *
51 * <p> <b>WARNING:</b> The {@code ElementVisitor} interface
52 * implemented by this class may have methods added to it in the
53 * future to accommodate new, currently unknown, language structures
54 * added to future versions of the Java™ programming language.
55 * Therefore, methods whose names begin with {@code "visit"} may be
56 * added to this class in the future; to avoid incompatibilities,
57 * classes which extend this class should not declare any instance
58 * methods with names beginning with {@code "visit"}.
59 *
60 * <p>When such a new visit method is added, the default
61 * implementation in this class will be to call the {@link
62 * #visitUnknown visitUnknown} method. A new simple element visitor
63 * class will also be introduced to correspond to the new language
64 * level; this visitor will have different default behavior for the
65 * visit method in question. When the new visitor is introduced, all
66 * or portions of this visitor may be deprecated.
67 *
68 * @param <R> the return type of this visitor's methods. Use {@code Void}
69 * for visitors that do not need to return results.
70 * @param <P> the type of the additional parameter to this visitor's methods. Use {@code Void}
71 * for visitors that do not need an additional parameter.
72 *
73 * @author Joseph D. Darcy
74 * @author Scott Seligman
75 * @author Peter von der Ahé
76 *
77 * @see SimpleElementVisitor7
78 * @see SimpleElementVisitor8
79 * @see SimpleElementVisitor9
80 * @see SimpleElementVisitor14
81 * @since 1.6
82 */
83 @SupportedSourceVersion(RELEASE_6)
84 public class SimpleElementVisitor6<R, P> extends AbstractElementVisitor6<R, P> {
85 /**
86 * Default value to be returned; {@link #defaultAction
|
1 /*
2 * Copyright (c) 2005, 2020, 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
26 package javax.lang.model.util;
27
28 import javax.lang.model.element.*;
29 import javax.annotation.processing.SupportedSourceVersion;
30 import javax.lang.model.SourceVersion;
31 import static javax.lang.model.SourceVersion.*;
32
33
34 /**
35 * A simple visitor of program elements with default behavior
36 * appropriate for the {@link SourceVersion#RELEASE_6 RELEASE_6}
37 * source version.
38 *
39 * Visit methods corresponding to {@code RELEASE_6} language
40 * constructs call {@link #defaultAction defaultAction}, passing their
41 * arguments to {@code defaultAction}'s corresponding parameters.
42 *
43 * For constructs introduced in {@code RELEASE_7} and later, {@code
44 * visitUnknown} is called instead.
45 *
46 *
47 * @apiNote
48 * Methods in this class may be overridden subject to their general
49 * contract.
50 *
51 * <p id=note_for_subclasses><strong>WARNING:</strong> The {@code
52 * ElementVisitor} interface implemented by this class may have
53 * methods added to it in the future to accommodate new, currently
54 * unknown, language structures added to future versions of the
55 * Java™ programming language. Therefore, methods whose names
56 * begin with {@code "visit"} may be added to this class in the
57 * future; to avoid incompatibilities, classes and subclasses which
58 * extend this class should not declare any instance methods with
59 * names beginning with {@code "visit"}.</p>
60 *
61 * <p>When such a new visit method is added, the default
62 * implementation in this class will be to directly or indirectly call
63 * the {@link #visitUnknown visitUnknown} method. A new simple
64 * element visitor class will also be introduced to correspond to the
65 * new language level; this visitor will have different default
66 * behavior for the visit method in question. When a new visitor is
67 * introduced, portions of this visitor class may be deprecated,
68 * including its constructors.
69 *
70 * @param <R> the return type of this visitor's methods. Use {@code Void}
71 * for visitors that do not need to return results.
72 * @param <P> the type of the additional parameter to this visitor's methods. Use {@code Void}
73 * for visitors that do not need an additional parameter.
74 *
75 * @author Joseph D. Darcy
76 * @author Scott Seligman
77 * @author Peter von der Ahé
78 *
79 * @see SimpleElementVisitor7
80 * @see SimpleElementVisitor8
81 * @see SimpleElementVisitor9
82 * @see SimpleElementVisitor14
83 * @since 1.6
84 */
85 @SupportedSourceVersion(RELEASE_6)
86 public class SimpleElementVisitor6<R, P> extends AbstractElementVisitor6<R, P> {
87 /**
88 * Default value to be returned; {@link #defaultAction
|