1 /*
   2  * Copyright (c) 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
  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.RecordComponentElement;
  31 import static javax.lang.model.SourceVersion.*;
  32 
  33 /**
  34  * {@preview Associated with records, a preview feature of the Java language.
  35  *
  36  *           This class is associated with <i>records</i>, a preview
  37  *           feature of the Java language. Preview features
  38  *           may be removed in a future release, or upgraded to permanent
  39  *           features of the Java language.}
  40  *
  41  * A skeletal visitor of program elements with default behavior
  42  * appropriate for the {@link SourceVersion#RELEASE_14 RELEASE_14}
  43  * source version.
  44  *
  45  * <p> <b>WARNING:</b> The {@code ElementVisitor} interface
  46  * implemented by this class may have methods added to it in the
  47  * future to accommodate new, currently unknown, language structures
  48  * added to future versions of the Java&trade; programming language.
  49  * Therefore, methods whose names begin with {@code "visit"} may be
  50  * added to this class in the future; to avoid incompatibilities,
  51  * classes which extend this class should not declare any instance
  52  * methods with names beginning with {@code "visit"}.
  53  *
  54  * <p>When such a new visit method is added, the default
  55  * implementation in this class will be to call the {@link
  56  * #visitUnknown visitUnknown} method.  A new abstract element visitor
  57  * class will also be introduced to correspond to the new language
  58  * level; this visitor will have different default behavior for the
  59  * visit method in question.  When the new visitor is introduced, all
  60  * or portions of this visitor may be deprecated.
  61  *
  62  * @param <R> the return type of this visitor's methods.  Use {@link
  63  *            Void} for visitors that do not need to return results.
  64  * @param <P> the type of the additional parameter to this visitor's
  65  *            methods.  Use {@code Void} for visitors that do not need an
  66  *            additional parameter.
  67  *
  68  * @see AbstractElementVisitor6
  69  * @see AbstractElementVisitor7
  70  * @see AbstractElementVisitor8
  71  * @see AbstractElementVisitor9
  72  * @since 14
  73  */
  74 @jdk.internal.PreviewFeature(feature=jdk.internal.PreviewFeature.Feature.RECORDS,
  75                              essentialAPI=false)
  76 @SupportedSourceVersion(RELEASE_14)
  77 public abstract class AbstractElementVisitor14<R, P> extends AbstractElementVisitor9<R, P> {
  78     /**
  79      * Constructor for concrete subclasses to call.
  80      */
  81     protected AbstractElementVisitor14(){
  82         super();
  83     }
  84 
  85     /**
  86      * {@inheritDoc}
  87      *
  88      * @implSpec Visits a {@code RecordComponentElement} in a manner defined by a
  89      * subclass.
  90      *
  91      * @param t  {@inheritDoc}
  92      * @param p  {@inheritDoc}
  93      * @return   {@inheritDoc}
  94      */
  95     @SuppressWarnings("preview")
  96     @Override
  97     public abstract R visitRecordComponent(RecordComponentElement t, P p);
  98 }