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.lang.model.element.*; 29 import javax.annotation.processing.SupportedSourceVersion; 30 import javax.lang.model.SourceVersion; 31 import static javax.lang.model.SourceVersion.*; 32 33 34 /** 35 * A scanning visitor of program elements with default behavior 36 * appropriate for the {@link SourceVersion#RELEASE_7 RELEASE_7} 37 * source version. The <code>visit<i>Xyz</i></code> methods in this 38 * class scan their component elements by calling {@code scan} on 39 * their {@linkplain Element#getEnclosedElements enclosed elements}, 40 * {@linkplain ExecutableElement#getParameters parameters}, etc., as 41 * indicated in the individual method specifications. A subclass can 42 * control the order elements are visited by overriding the 43 * <code>visit<i>Xyz</i></code> methods. Note that clients of a scanner 44 * may get the desired behavior be invoking {@code v.scan(e, p)} rather 45 * than {@code v.visit(e, p)} on the root objects of interest. 46 * 47 * <p>When a subclass overrides a <code>visit<i>Xyz</i></code> method, the 48 * new method can cause the enclosed elements to be scanned in the 49 * default way by calling <code>super.visit<i>Xyz</i></code>. In this 50 * fashion, the concrete visitor can control the ordering of traversal 51 * over the component elements with respect to the additional 52 * processing; for example, consistently calling 53 * <code>super.visit<i>Xyz</i></code> at the start of the overridden 54 * methods will yield a preorder traversal, etc. If the component 55 * elements should be traversed in some other order, instead of 56 * calling <code>super.visit<i>Xyz</i></code>, an overriding visit method 57 * should call {@code scan} with the elements in the desired order. 58 * 59 * @apiNote 60 * Methods in this class may be overridden subject to their 61 * general contract. 62 * 63 * @param <R> the return type of this visitor's methods. Use {@link 64 * Void} for visitors that do not need to return results. 65 * @param <P> the type of the additional parameter to this visitor's 66 * methods. Use {@code Void} for visitors that do not need an 67 * additional parameter. 68 * 69 * @see <a href="ElementScanner6.html#note_for_subclasses"><strong>Compatibility note for subclasses</strong></a> 70 * @see ElementScanner6 71 * @see ElementScanner8 72 * @see ElementScanner9 73 * @see ElementScanner14 74 * @since 1.7 75 */ 76 @SupportedSourceVersion(RELEASE_7) 77 public class ElementScanner7<R, P> extends ElementScanner6<R, P> { 78 /** 79 * Constructor for concrete subclasses; uses {@code null} for the 80 * 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 ElementScanner7(){ 87 super(null); // Superclass constructor deprecated too 88 } 89 90 /** 91 * Constructor for concrete subclasses; uses the argument for the 92 * default value. 93 * 94 * @param defaultValue the default value 95 * 96 * @deprecated Release 7 is obsolete; update to a visitor for a newer 97 * release level. 98 */ 99 @Deprecated(since="12") 100 protected ElementScanner7(R defaultValue){ 101 super(defaultValue); // Superclass constructor deprecated too 102 } 103 104 /** 105 * {@inheritDoc} 106 * 107 * @implSpec This implementation scans the enclosed elements. 108 * 109 * @param e {@inheritDoc} 110 * @param p {@inheritDoc} 111 * @return the result of scanning 112 */ 113 @Override 114 public R visitVariable(VariableElement e, P p) { 115 return scan(e.getEnclosedElements(), p); 116 } 117 }