Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/javax/lang/model/util/ElementScanner8.java@c75be5bc5283 (annotated)
src/share/classes/javax/lang/model/util/ElementScanner8.java
Tue, 09 Oct 2012 19:10:00 -0700
- author
- jjg
- date
- Tue, 09 Oct 2012 19:10:00 -0700
- changeset 1357
- c75be5bc5283
- parent 1054
- 111bbf1ad913
- child 1823
- b7a10bc02e7a
- permissions
- -rw-r--r--
8000663: clean up langtools imports
Reviewed-by: darcy
| darcy@1054 | 1 | /* |
| jjg@1357 | 2 | * Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved. |
| darcy@1054 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| darcy@1054 | 4 | * |
| darcy@1054 | 5 | * This code is free software; you can redistribute it and/or modify it |
| darcy@1054 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| darcy@1054 | 7 | * published by the Free Software Foundation. Oracle designates this |
| darcy@1054 | 8 | * particular file as subject to the "Classpath" exception as provided |
| darcy@1054 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| darcy@1054 | 10 | * |
| darcy@1054 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| darcy@1054 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| darcy@1054 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| darcy@1054 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| darcy@1054 | 15 | * accompanied this code). |
| darcy@1054 | 16 | * |
| darcy@1054 | 17 | * You should have received a copy of the GNU General Public License version |
| darcy@1054 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| darcy@1054 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| darcy@1054 | 20 | * |
| darcy@1054 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| darcy@1054 | 22 | * or visit www.oracle.com if you need additional information or have any |
| darcy@1054 | 23 | * questions. |
| darcy@1054 | 24 | */ |
| darcy@1054 | 25 | |
| darcy@1054 | 26 | package javax.lang.model.util; |
| darcy@1054 | 27 | |
| darcy@1054 | 28 | import javax.lang.model.element.*; |
| darcy@1054 | 29 | import javax.annotation.processing.SupportedSourceVersion; |
| darcy@1054 | 30 | import javax.lang.model.SourceVersion; |
| darcy@1054 | 31 | import static javax.lang.model.SourceVersion.*; |
| darcy@1054 | 32 | |
| darcy@1054 | 33 | |
| darcy@1054 | 34 | /** |
| darcy@1054 | 35 | * A scanning visitor of program elements with default behavior |
| darcy@1054 | 36 | * appropriate for the {@link SourceVersion#RELEASE_8 RELEASE_8} |
| darcy@1054 | 37 | * source version. The <tt>visit<i>XYZ</i></tt> methods in this |
| darcy@1054 | 38 | * class scan their component elements by calling {@code scan} on |
| darcy@1054 | 39 | * their {@linkplain Element#getEnclosedElements enclosed elements}, |
| darcy@1054 | 40 | * {@linkplain ExecutableElement#getParameters parameters}, etc., as |
| darcy@1054 | 41 | * indicated in the individual method specifications. A subclass can |
| darcy@1054 | 42 | * control the order elements are visited by overriding the |
| darcy@1054 | 43 | * <tt>visit<i>XYZ</i></tt> methods. Note that clients of a scanner |
| darcy@1054 | 44 | * may get the desired behavior be invoking {@code v.scan(e, p)} rather |
| darcy@1054 | 45 | * than {@code v.visit(e, p)} on the root objects of interest. |
| darcy@1054 | 46 | * |
| darcy@1054 | 47 | * <p>When a subclass overrides a <tt>visit<i>XYZ</i></tt> method, the |
| darcy@1054 | 48 | * new method can cause the enclosed elements to be scanned in the |
| darcy@1054 | 49 | * default way by calling <tt>super.visit<i>XYZ</i></tt>. In this |
| darcy@1054 | 50 | * fashion, the concrete visitor can control the ordering of traversal |
| darcy@1054 | 51 | * over the component elements with respect to the additional |
| darcy@1054 | 52 | * processing; for example, consistently calling |
| darcy@1054 | 53 | * <tt>super.visit<i>XYZ</i></tt> at the start of the overridden |
| darcy@1054 | 54 | * methods will yield a preorder traversal, etc. If the component |
| darcy@1054 | 55 | * elements should be traversed in some other order, instead of |
| darcy@1054 | 56 | * calling <tt>super.visit<i>XYZ</i></tt>, an overriding visit method |
| darcy@1054 | 57 | * should call {@code scan} with the elements in the desired order. |
| darcy@1054 | 58 | * |
| darcy@1054 | 59 | * <p> Methods in this class may be overridden subject to their |
| darcy@1054 | 60 | * general contract. Note that annotating methods in concrete |
| darcy@1054 | 61 | * subclasses with {@link java.lang.Override @Override} will help |
| darcy@1054 | 62 | * ensure that methods are overridden as intended. |
| darcy@1054 | 63 | * |
| darcy@1054 | 64 | * <p> <b>WARNING:</b> The {@code ElementVisitor} interface |
| darcy@1054 | 65 | * implemented by this class may have methods added to it in the |
| darcy@1054 | 66 | * future to accommodate new, currently unknown, language structures |
| darcy@1054 | 67 | * added to future versions of the Java™ programming language. |
| darcy@1054 | 68 | * Therefore, methods whose names begin with {@code "visit"} may be |
| darcy@1054 | 69 | * added to this class in the future; to avoid incompatibilities, |
| darcy@1054 | 70 | * classes which extend this class should not declare any instance |
| darcy@1054 | 71 | * methods with names beginning with {@code "visit"}. |
| darcy@1054 | 72 | * |
| darcy@1054 | 73 | * <p>When such a new visit method is added, the default |
| darcy@1054 | 74 | * implementation in this class will be to call the {@link |
| darcy@1054 | 75 | * #visitUnknown visitUnknown} method. A new element scanner visitor |
| darcy@1054 | 76 | * class will also be introduced to correspond to the new language |
| darcy@1054 | 77 | * level; this visitor will have different default behavior for the |
| darcy@1054 | 78 | * visit method in question. When the new visitor is introduced, all |
| darcy@1054 | 79 | * or portions of this visitor may be deprecated. |
| darcy@1054 | 80 | * |
| darcy@1054 | 81 | * @param <R> the return type of this visitor's methods. Use {@link |
| darcy@1054 | 82 | * Void} for visitors that do not need to return results. |
| darcy@1054 | 83 | * @param <P> the type of the additional parameter to this visitor's |
| darcy@1054 | 84 | * methods. Use {@code Void} for visitors that do not need an |
| darcy@1054 | 85 | * additional parameter. |
| darcy@1054 | 86 | * |
| darcy@1054 | 87 | * @see ElementScanner6 |
| darcy@1054 | 88 | * @see ElementScanner7 |
| darcy@1054 | 89 | * @since 1.8 |
| darcy@1054 | 90 | */ |
| darcy@1054 | 91 | @SupportedSourceVersion(RELEASE_8) |
| darcy@1054 | 92 | public class ElementScanner8<R, P> extends ElementScanner7<R, P> { |
| darcy@1054 | 93 | /** |
| darcy@1054 | 94 | * Constructor for concrete subclasses; uses {@code null} for the |
| darcy@1054 | 95 | * default value. |
| darcy@1054 | 96 | */ |
| darcy@1054 | 97 | protected ElementScanner8(){ |
| darcy@1054 | 98 | super(null); |
| darcy@1054 | 99 | } |
| darcy@1054 | 100 | |
| darcy@1054 | 101 | /** |
| darcy@1054 | 102 | * Constructor for concrete subclasses; uses the argument for the |
| darcy@1054 | 103 | * default value. |
| darcy@1054 | 104 | */ |
| darcy@1054 | 105 | protected ElementScanner8(R defaultValue){ |
| darcy@1054 | 106 | super(defaultValue); |
| darcy@1054 | 107 | } |
| darcy@1054 | 108 | } |
