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 simple visitor of program elements with default behavior 42 * appropriate for the {@link SourceVersion#RELEASE_14 RELEASE_14} 43 * source version. 44 * 45 * Visit methods corresponding to {@code RELEASE_14} and earlier 46 * language constructs call {@link #defaultAction defaultAction}, 47 * passing their arguments to {@code defaultAction}'s corresponding 48 * parameters. 49 * 50 * <p> Methods in this class may be overridden subject to their 51 * general contract. Note that annotating methods in concrete 52 * subclasses with {@link java.lang.Override @Override} will help 53 * ensure that methods are overridden as intended. 54 * 55 * <p> <b>WARNING:</b> The {@code ElementVisitor} interface 56 * implemented by this class may have methods added to it in the 57 * future to accommodate new, currently unknown, language structures 58 * added to future versions of the Java™ programming language. 59 * Therefore, methods whose names begin with {@code "visit"} may be 60 * added to this class in the future; to avoid incompatibilities, 61 * classes which extend this class should not declare any instance 62 * methods with names beginning with {@code "visit"}. 63 * 64 * <p>When such a new visit method is added, the default 65 * implementation in this class will be to call the {@link 66 * #visitUnknown visitUnknown} method. A new simple element visitor 67 * class will also be introduced to correspond to the new language 68 * level; this visitor will have different default behavior for the 69 * visit method in question. When the new visitor is introduced, all 70 * or portions of this visitor may be deprecated. 71 * 72 * @param <R> the return type of this visitor's methods. Use {@code Void} 73 * for visitors that do not need to return results. 74 * @param <P> the type of the additional parameter to this visitor's methods. Use {@code Void} 75 * for visitors that do not need an additional parameter. 76 * 77 * @see SimpleElementVisitor6 78 * @see SimpleElementVisitor7 79 * @see SimpleElementVisitor8 80 * @see SimpleElementVisitor9 81 * @since 14 82 */ 83 @jdk.internal.PreviewFeature(feature=jdk.internal.PreviewFeature.Feature.RECORDS, 84 essentialAPI=false) 85 @SupportedSourceVersion(RELEASE_14) 86 public class SimpleElementVisitor14<R, P> extends SimpleElementVisitor9<R, P> { 87 /** 88 * Constructor for concrete subclasses; uses {@code null} for the 89 * default value. 90 */ 91 protected SimpleElementVisitor14(){ 92 super(null); 93 } 94 95 /** 96 * Constructor for concrete subclasses; uses the argument for the 97 * default value. 98 * 99 * @param defaultValue the value to assign to {@link #DEFAULT_VALUE} 100 */ 101 protected SimpleElementVisitor14(R defaultValue){ 102 super(defaultValue); 103 } 104 105 /** 106 * {@inheritDoc} 107 * 108 * @implSpec Visits a {@code RecordComponentElement} by calling {@code 109 * defaultAction}. 110 * 111 * @param e the element to visit 112 * @param p a visitor-specified parameter 113 * @return {@inheritDoc} 114 */ 115 @SuppressWarnings("preview") 116 @Override 117 public R visitRecordComponent(RecordComponentElement e, P p) { 118 return defaultAction(e, p); 119 } 120 }