src/share/classes/javax/lang/model/util/ElementScanner7.java

Tue, 28 Dec 2010 15:54:52 -0800

author
ohair
date
Tue, 28 Dec 2010 15:54:52 -0800
changeset 798
4868a36f6fd8
parent 575
9a7c998bf2fc
child 851
cad51b6eb7a6
permissions
-rw-r--r--

6962318: Update copyright year
Reviewed-by: xdono

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

mercurial