1 /*
   2  * Copyright (c) 2010, 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
  23  * questions.
  24  */
  25 
  26 package javax.lang.model.util;
  27 
  28 import javax.annotation.processing.SupportedSourceVersion;
  29 import javax.lang.model.SourceVersion;
  30 import javax.lang.model.element.*;
  31 import static javax.lang.model.SourceVersion.*;
  32 
  33 /**
  34  * A visitor of program elements based on their {@linkplain
  35  * ElementKind kind} with default behavior appropriate for the {@link
  36  * SourceVersion#RELEASE_7 RELEASE_7} source version.  For {@linkplain
  37  * Element elements} <code><i>Xyz</i></code> that may have more than one
  38  * kind, the <code>visit<i>Xyz</i></code> methods in this class delegate
  39  * to the <code>visit<i>Xyz</i>As<i>Kind</i></code> method corresponding to the
  40  * first argument's kind.  The <code>visit<i>Xyz</i>As<i>Kind</i></code> methods
  41  * call {@link #defaultAction defaultAction}, passing their arguments
  42  * to {@code defaultAction}'s corresponding parameters.
  43  *
  44  * @apiNote
  45  * Methods in this class may be overridden subject to their
  46  * general contract.
  47  *
  48  * @param <R> the return type of this visitor's methods.  Use {@link
  49  *            Void} for visitors that do not need to return results.
  50  * @param <P> the type of the additional parameter to this visitor's
  51  *            methods.  Use {@code Void} for visitors that do not need an
  52  *            additional parameter.
  53  *
  54  * @see <a href="ElementKindVisitor6.html#note_for_subclasses">
  55  * <strong>Compatibility note for subclasses</strong></a>
  56  * @see ElementKindVisitor6
  57  * @see ElementKindVisitor8
  58  * @see ElementKindVisitor9
  59  * @see ElementKindVisitor14
  60  * @since 1.7
  61  */
  62 @SupportedSourceVersion(RELEASE_7)
  63 public class ElementKindVisitor7<R, P> extends ElementKindVisitor6<R, P> {
  64     /**
  65      * Constructor for concrete subclasses; uses {@code null} for the
  66      * default value.
  67      *
  68      * @deprecated Release 7 is obsolete; update to a visitor for a newer
  69      * release level.
  70      */
  71     @Deprecated(since="12")
  72     protected ElementKindVisitor7() {
  73         super(null); // Superclass constructor deprecated too
  74     }
  75 
  76     /**
  77      * Constructor for concrete subclasses; uses the argument for the
  78      * default value.
  79      *
  80      * @param defaultValue the value to assign to {@link #DEFAULT_VALUE}
  81      *
  82      * @deprecated Release 7 is obsolete; update to a visitor for a newer
  83      * release level.
  84      */
  85     @Deprecated(since="12")
  86     protected ElementKindVisitor7(R defaultValue) {
  87         super(defaultValue); // Superclass constructor deprecated too
  88     }
  89 
  90     /**
  91      * {@inheritDoc}
  92      *
  93      * @implSpec This implementation calls {@code defaultAction}.
  94      *
  95      * @param e {@inheritDoc}
  96      * @param p {@inheritDoc}
  97      * @return  the result of {@code defaultAction}
  98      */
  99     @Override
 100     public R visitVariableAsResourceVariable(VariableElement e, P p) {
 101         return defaultAction(e, p);
 102     }
 103 }