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