Tue, 09 Oct 2012 19:10:00 -0700
8000663: clean up langtools imports
Reviewed-by: darcy
darcy@575 | 1 | /* |
jjg@1357 | 2 | * Copyright (c) 2010, 2012, Oracle and/or its affiliates. All rights reserved. |
darcy@575 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
darcy@575 | 4 | * |
darcy@575 | 5 | * This code is free software; you can redistribute it and/or modify it |
darcy@575 | 6 | * under the terms of the GNU General Public License version 2 only, as |
darcy@575 | 7 | * published by the Free Software Foundation. Oracle designates this |
darcy@575 | 8 | * particular file as subject to the "Classpath" exception as provided |
darcy@575 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
darcy@575 | 10 | * |
darcy@575 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
darcy@575 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
darcy@575 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
darcy@575 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
darcy@575 | 15 | * accompanied this code). |
darcy@575 | 16 | * |
darcy@575 | 17 | * You should have received a copy of the GNU General Public License version |
darcy@575 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
darcy@575 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
darcy@575 | 20 | * |
darcy@575 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
darcy@575 | 22 | * or visit www.oracle.com if you need additional information or have any |
darcy@575 | 23 | * questions. |
darcy@575 | 24 | */ |
darcy@575 | 25 | |
darcy@575 | 26 | package javax.lang.model.util; |
darcy@575 | 27 | |
jjg@1357 | 28 | import javax.annotation.processing.SupportedSourceVersion; |
jjg@1357 | 29 | import javax.lang.model.SourceVersion; |
darcy@575 | 30 | import javax.lang.model.element.*; |
darcy@575 | 31 | import static javax.lang.model.SourceVersion.*; |
darcy@575 | 32 | |
darcy@575 | 33 | /** |
darcy@575 | 34 | * A visitor of program elements based on their {@linkplain |
darcy@575 | 35 | * ElementKind kind} with default behavior appropriate for the {@link |
darcy@851 | 36 | * SourceVersion#RELEASE_7 RELEASE_7} source version. For {@linkplain |
darcy@575 | 37 | * Element elements} <tt><i>XYZ</i></tt> that may have more than one |
darcy@575 | 38 | * kind, the <tt>visit<i>XYZ</i></tt> methods in this class delegate |
darcy@575 | 39 | * to the <tt>visit<i>XYZKind</i></tt> method corresponding to the |
darcy@575 | 40 | * first argument's kind. The <tt>visit<i>XYZKind</i></tt> methods |
darcy@575 | 41 | * call {@link #defaultAction defaultAction}, passing their arguments |
darcy@575 | 42 | * to {@code defaultAction}'s corresponding parameters. |
darcy@575 | 43 | * |
darcy@575 | 44 | * <p> Methods in this class may be overridden subject to their |
darcy@575 | 45 | * general contract. Note that annotating methods in concrete |
darcy@575 | 46 | * subclasses with {@link java.lang.Override @Override} will help |
darcy@575 | 47 | * ensure that methods are overridden as intended. |
darcy@575 | 48 | * |
darcy@575 | 49 | * <p> <b>WARNING:</b> The {@code ElementVisitor} interface |
darcy@575 | 50 | * implemented by this class may have methods added to it or the |
darcy@575 | 51 | * {@code ElementKind} {@code enum} used in this case may have |
darcy@575 | 52 | * constants added to it in the future to accommodate new, currently |
darcy@575 | 53 | * unknown, language structures added to future versions of the |
darcy@575 | 54 | * Java™ programming language. Therefore, methods whose names |
darcy@575 | 55 | * begin with {@code "visit"} may be added to this class in the |
darcy@575 | 56 | * future; to avoid incompatibilities, classes which extend this class |
darcy@575 | 57 | * should not declare any instance methods with names beginning with |
darcy@575 | 58 | * {@code "visit"}. |
darcy@575 | 59 | * |
darcy@575 | 60 | * <p>When such a new visit method is added, the default |
darcy@575 | 61 | * implementation in this class will be to call the {@link |
darcy@575 | 62 | * #visitUnknown visitUnknown} method. A new abstract element kind |
darcy@575 | 63 | * visitor class will also be introduced to correspond to the new |
darcy@575 | 64 | * language level; this visitor will have different default behavior |
darcy@575 | 65 | * for the visit method in question. When the new visitor is |
darcy@575 | 66 | * introduced, all or portions of this visitor may be deprecated. |
darcy@575 | 67 | * |
darcy@575 | 68 | * @param <R> the return type of this visitor's methods. Use {@link |
darcy@575 | 69 | * Void} for visitors that do not need to return results. |
darcy@575 | 70 | * @param <P> the type of the additional parameter to this visitor's |
darcy@575 | 71 | * methods. Use {@code Void} for visitors that do not need an |
darcy@575 | 72 | * additional parameter. |
darcy@575 | 73 | * |
darcy@575 | 74 | * @see ElementKindVisitor6 |
darcy@1054 | 75 | * @see ElementKindVisitor8 |
darcy@575 | 76 | * @since 1.7 |
darcy@575 | 77 | */ |
darcy@575 | 78 | @SupportedSourceVersion(RELEASE_7) |
darcy@575 | 79 | public class ElementKindVisitor7<R, P> extends ElementKindVisitor6<R, P> { |
darcy@575 | 80 | /** |
darcy@575 | 81 | * Constructor for concrete subclasses; uses {@code null} for the |
darcy@575 | 82 | * default value. |
darcy@575 | 83 | */ |
darcy@575 | 84 | protected ElementKindVisitor7() { |
darcy@575 | 85 | super(null); |
darcy@575 | 86 | } |
darcy@575 | 87 | |
darcy@575 | 88 | /** |
darcy@575 | 89 | * Constructor for concrete subclasses; uses the argument for the |
darcy@575 | 90 | * default value. |
darcy@575 | 91 | * |
darcy@575 | 92 | * @param defaultValue the value to assign to {@link #DEFAULT_VALUE} |
darcy@575 | 93 | */ |
darcy@575 | 94 | protected ElementKindVisitor7(R defaultValue) { |
darcy@575 | 95 | super(defaultValue); |
darcy@575 | 96 | } |
darcy@851 | 97 | |
darcy@851 | 98 | /** |
darcy@851 | 99 | * Visits a {@code RESOURCE_VARIABLE} variable element by calling |
darcy@851 | 100 | * {@code defaultAction}. |
darcy@851 | 101 | * |
darcy@851 | 102 | * @param e {@inheritDoc} |
darcy@851 | 103 | * @param p {@inheritDoc} |
darcy@851 | 104 | * @return the result of {@code defaultAction} |
darcy@851 | 105 | */ |
darcy@851 | 106 | @Override |
darcy@851 | 107 | public R visitVariableAsResourceVariable(VariableElement e, P p) { |
darcy@851 | 108 | return defaultAction(e, p); |
darcy@851 | 109 | } |
darcy@575 | 110 | } |