Tue, 09 Oct 2012 19:10:00 -0700
8000663: clean up langtools imports
Reviewed-by: darcy
duke@1 | 1 | /* |
jjg@1357 | 2 | * Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package javax.lang.model.util; |
duke@1 | 27 | |
duke@1 | 28 | import javax.lang.model.element.*; |
duke@1 | 29 | import javax.annotation.processing.SupportedSourceVersion; |
duke@1 | 30 | import javax.lang.model.SourceVersion; |
duke@1 | 31 | import static javax.lang.model.SourceVersion.*; |
duke@1 | 32 | |
duke@1 | 33 | |
duke@1 | 34 | /** |
duke@1 | 35 | * A scanning visitor of program elements with default behavior |
duke@1 | 36 | * appropriate for the {@link SourceVersion#RELEASE_6 RELEASE_6} |
duke@1 | 37 | * source version. The <tt>visit<i>XYZ</i></tt> methods in this |
duke@1 | 38 | * class scan their component elements by calling {@code scan} on |
duke@1 | 39 | * their {@linkplain Element#getEnclosedElements enclosed elements}, |
duke@1 | 40 | * {@linkplain ExecutableElement#getParameters parameters}, etc., as |
duke@1 | 41 | * indicated in the individual method specifications. A subclass can |
duke@1 | 42 | * control the order elements are visited by overriding the |
duke@1 | 43 | * <tt>visit<i>XYZ</i></tt> methods. Note that clients of a scanner |
duke@1 | 44 | * may get the desired behavior be invoking {@code v.scan(e, p)} rather |
duke@1 | 45 | * than {@code v.visit(e, p)} on the root objects of interest. |
duke@1 | 46 | * |
duke@1 | 47 | * <p>When a subclass overrides a <tt>visit<i>XYZ</i></tt> method, the |
duke@1 | 48 | * new method can cause the enclosed elements to be scanned in the |
duke@1 | 49 | * default way by calling <tt>super.visit<i>XYZ</i></tt>. In this |
duke@1 | 50 | * fashion, the concrete visitor can control the ordering of traversal |
duke@1 | 51 | * over the component elements with respect to the additional |
duke@1 | 52 | * processing; for example, consistently calling |
duke@1 | 53 | * <tt>super.visit<i>XYZ</i></tt> at the start of the overridden |
duke@1 | 54 | * methods will yield a preorder traversal, etc. If the component |
duke@1 | 55 | * elements should be traversed in some other order, instead of |
duke@1 | 56 | * calling <tt>super.visit<i>XYZ</i></tt>, an overriding visit method |
duke@1 | 57 | * should call {@code scan} with the elements in the desired order. |
duke@1 | 58 | * |
duke@1 | 59 | * <p> Methods in this class may be overridden subject to their |
duke@1 | 60 | * general contract. Note that annotating methods in concrete |
duke@1 | 61 | * subclasses with {@link java.lang.Override @Override} will help |
duke@1 | 62 | * ensure that methods are overridden as intended. |
duke@1 | 63 | * |
duke@1 | 64 | * <p> <b>WARNING:</b> The {@code ElementVisitor} interface |
duke@1 | 65 | * implemented by this class may have methods added to it in the |
duke@1 | 66 | * future to accommodate new, currently unknown, language structures |
duke@1 | 67 | * added to future versions of the Java™ programming language. |
duke@1 | 68 | * Therefore, methods whose names begin with {@code "visit"} may be |
duke@1 | 69 | * added to this class in the future; to avoid incompatibilities, |
duke@1 | 70 | * classes which extend this class should not declare any instance |
duke@1 | 71 | * methods with names beginning with {@code "visit"}. |
duke@1 | 72 | * |
duke@1 | 73 | * <p>When such a new visit method is added, the default |
duke@1 | 74 | * implementation in this class will be to call the {@link |
duke@1 | 75 | * #visitUnknown visitUnknown} method. A new element scanner visitor |
duke@1 | 76 | * class will also be introduced to correspond to the new language |
duke@1 | 77 | * level; this visitor will have different default behavior for the |
duke@1 | 78 | * visit method in question. When the new visitor is introduced, all |
duke@1 | 79 | * or portions of this visitor may be deprecated. |
duke@1 | 80 | * |
duke@1 | 81 | * @param <R> the return type of this visitor's methods. Use {@link |
duke@1 | 82 | * Void} for visitors that do not need to return results. |
duke@1 | 83 | * @param <P> the type of the additional parameter to this visitor's |
duke@1 | 84 | * methods. Use {@code Void} for visitors that do not need an |
duke@1 | 85 | * additional parameter. |
duke@1 | 86 | * |
duke@1 | 87 | * @author Joseph D. Darcy |
duke@1 | 88 | * @author Scott Seligman |
duke@1 | 89 | * @author Peter von der Ahé |
darcy@575 | 90 | * |
darcy@575 | 91 | * @see ElementScanner7 |
darcy@1054 | 92 | * @see ElementScanner8 |
duke@1 | 93 | * @since 1.6 |
duke@1 | 94 | */ |
duke@1 | 95 | @SupportedSourceVersion(RELEASE_6) |
duke@1 | 96 | public class ElementScanner6<R, P> extends AbstractElementVisitor6<R, P> { |
duke@1 | 97 | /** |
duke@1 | 98 | * The specified default value. |
duke@1 | 99 | */ |
duke@1 | 100 | protected final R DEFAULT_VALUE; |
duke@1 | 101 | |
duke@1 | 102 | /** |
duke@1 | 103 | * Constructor for concrete subclasses; uses {@code null} for the |
duke@1 | 104 | * default value. |
duke@1 | 105 | */ |
duke@1 | 106 | protected ElementScanner6(){ |
duke@1 | 107 | DEFAULT_VALUE = null; |
duke@1 | 108 | } |
duke@1 | 109 | |
duke@1 | 110 | /** |
duke@1 | 111 | * Constructor for concrete subclasses; uses the argument for the |
duke@1 | 112 | * default value. |
duke@1 | 113 | */ |
duke@1 | 114 | protected ElementScanner6(R defaultValue){ |
duke@1 | 115 | DEFAULT_VALUE = defaultValue; |
duke@1 | 116 | } |
duke@1 | 117 | |
duke@1 | 118 | /** |
duke@1 | 119 | * Iterates over the given elements and calls {@link |
duke@1 | 120 | * #scan(Element, Object) scan(Element, P)} on each one. Returns |
duke@1 | 121 | * the result of the last call to {@code scan} or {@code |
duke@1 | 122 | * DEFAULT_VALUE} for an empty iterable. |
duke@1 | 123 | * |
duke@1 | 124 | * @param iterable the elements to scan |
duke@1 | 125 | * @param p additional parameter |
duke@1 | 126 | * @return the scan of the last element or {@code DEFAULT_VALUE} if no elements |
duke@1 | 127 | */ |
duke@1 | 128 | public final R scan(Iterable<? extends Element> iterable, P p) { |
duke@1 | 129 | R result = DEFAULT_VALUE; |
duke@1 | 130 | for(Element e : iterable) |
duke@1 | 131 | result = scan(e, p); |
duke@1 | 132 | return result; |
duke@1 | 133 | } |
duke@1 | 134 | |
duke@1 | 135 | /** |
duke@1 | 136 | * Processes an element by calling {@code e.accept(this, p)}; |
duke@1 | 137 | * this method may be overridden by subclasses. |
duke@1 | 138 | * @return the result of visiting {@code e}. |
duke@1 | 139 | */ |
duke@1 | 140 | public R scan(Element e, P p) { |
duke@1 | 141 | return e.accept(this, p); |
duke@1 | 142 | } |
duke@1 | 143 | |
duke@1 | 144 | /** |
duke@1 | 145 | * Convenience method equivalent to {@code v.scan(e, null)}. |
duke@1 | 146 | * @return the result of scanning {@code e}. |
duke@1 | 147 | */ |
duke@1 | 148 | public final R scan(Element e) { |
duke@1 | 149 | return scan(e, null); |
duke@1 | 150 | } |
duke@1 | 151 | |
duke@1 | 152 | /** |
duke@1 | 153 | * {@inheritDoc} This implementation scans the enclosed elements. |
duke@1 | 154 | * |
darcy@851 | 155 | * @param e {@inheritDoc} |
darcy@851 | 156 | * @param p {@inheritDoc} |
duke@1 | 157 | * @return the result of scanning |
duke@1 | 158 | */ |
duke@1 | 159 | public R visitPackage(PackageElement e, P p) { |
duke@1 | 160 | return scan(e.getEnclosedElements(), p); |
duke@1 | 161 | } |
duke@1 | 162 | |
duke@1 | 163 | /** |
duke@1 | 164 | * {@inheritDoc} This implementation scans the enclosed elements. |
duke@1 | 165 | * |
darcy@851 | 166 | * @param e {@inheritDoc} |
darcy@851 | 167 | * @param p {@inheritDoc} |
duke@1 | 168 | * @return the result of scanning |
duke@1 | 169 | */ |
duke@1 | 170 | public R visitType(TypeElement e, P p) { |
duke@1 | 171 | return scan(e.getEnclosedElements(), p); |
duke@1 | 172 | } |
duke@1 | 173 | |
duke@1 | 174 | /** |
darcy@851 | 175 | * {@inheritDoc} |
duke@1 | 176 | * |
darcy@851 | 177 | * This implementation scans the enclosed elements, unless the |
darcy@851 | 178 | * element is a {@code RESOURCE_VARIABLE} in which case {@code |
darcy@851 | 179 | * visitUnknown} is called. |
darcy@851 | 180 | * |
darcy@851 | 181 | * @param e {@inheritDoc} |
darcy@851 | 182 | * @param p {@inheritDoc} |
duke@1 | 183 | * @return the result of scanning |
duke@1 | 184 | */ |
duke@1 | 185 | public R visitVariable(VariableElement e, P p) { |
darcy@851 | 186 | if (e.getKind() != ElementKind.RESOURCE_VARIABLE) |
darcy@851 | 187 | return scan(e.getEnclosedElements(), p); |
darcy@851 | 188 | else |
darcy@851 | 189 | return visitUnknown(e, p); |
duke@1 | 190 | } |
duke@1 | 191 | |
duke@1 | 192 | /** |
duke@1 | 193 | * {@inheritDoc} This implementation scans the parameters. |
duke@1 | 194 | * |
darcy@851 | 195 | * @param e {@inheritDoc} |
darcy@851 | 196 | * @param p {@inheritDoc} |
duke@1 | 197 | * @return the result of scanning |
duke@1 | 198 | */ |
duke@1 | 199 | public R visitExecutable(ExecutableElement e, P p) { |
duke@1 | 200 | return scan(e.getParameters(), p); |
duke@1 | 201 | } |
duke@1 | 202 | |
duke@1 | 203 | /** |
duke@1 | 204 | * {@inheritDoc} This implementation scans the enclosed elements. |
duke@1 | 205 | * |
darcy@851 | 206 | * @param e {@inheritDoc} |
darcy@851 | 207 | * @param p {@inheritDoc} |
duke@1 | 208 | * @return the result of scanning |
duke@1 | 209 | */ |
duke@1 | 210 | public R visitTypeParameter(TypeParameterElement e, P p) { |
duke@1 | 211 | return scan(e.getEnclosedElements(), p); |
duke@1 | 212 | } |
duke@1 | 213 | } |