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