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

Thu, 13 Sep 2012 14:29:36 -0700

author
jjg
date
Thu, 13 Sep 2012 14:29:36 -0700
changeset 1326
30c36e23f154
parent 1054
111bbf1ad913
child 1357
c75be5bc5283
permissions
-rw-r--r--

7177970: fix issues in langtools doc comments
Reviewed-by: mcimadamore

darcy@575 1 /*
darcy@851 2 * Copyright (c) 2010, 2011, 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 * A simple visitor of program elements with default behavior
darcy@575 36 * appropriate for the {@link SourceVersion#RELEASE_7 RELEASE_7}
darcy@575 37 * source version.
darcy@575 38 *
darcy@851 39 * Visit methods corresponding to {@code RELEASE_7} and earlier
darcy@851 40 * language constructs call {@link #defaultAction defaultAction},
darcy@851 41 * passing their arguments to {@code defaultAction}'s corresponding
darcy@851 42 * parameters.
darcy@575 43 *
darcy@575 44 * <p> Methods in this class may be overridden subject to their
darcy@575 45 * general contract. Note that annotating methods in concrete
darcy@575 46 * subclasses with {@link java.lang.Override @Override} will help
darcy@575 47 * ensure that methods are overridden as intended.
darcy@575 48 *
darcy@575 49 * <p> <b>WARNING:</b> The {@code ElementVisitor} interface
darcy@575 50 * implemented by this class may have methods added to it in the
darcy@575 51 * future to accommodate new, currently unknown, language structures
darcy@575 52 * added to future versions of the Java&trade; programming language.
darcy@575 53 * Therefore, methods whose names begin with {@code "visit"} may be
darcy@575 54 * added to this class in the future; to avoid incompatibilities,
darcy@575 55 * classes which extend this class should not declare any instance
darcy@575 56 * methods with names beginning with {@code "visit"}.
darcy@575 57 *
darcy@575 58 * <p>When such a new visit method is added, the default
darcy@575 59 * implementation in this class will be to call the {@link
darcy@575 60 * #visitUnknown visitUnknown} method. A new simple element visitor
darcy@575 61 * class will also be introduced to correspond to the new language
darcy@575 62 * level; this visitor will have different default behavior for the
darcy@575 63 * visit method in question. When the new visitor is introduced, all
darcy@575 64 * or portions of this visitor may be deprecated.
darcy@575 65 *
darcy@575 66 * @param <R> the return type of this visitor's methods. Use {@code Void}
darcy@575 67 * for visitors that do not need to return results.
darcy@575 68 * @param <P> the type of the additional parameter to this visitor's methods. Use {@code Void}
darcy@575 69 * for visitors that do not need an additional parameter.
darcy@575 70 *
darcy@575 71 * @see SimpleElementVisitor6
darcy@1054 72 * @see SimpleElementVisitor8
darcy@575 73 * @since 1.7
darcy@575 74 */
darcy@575 75 @SupportedSourceVersion(RELEASE_7)
darcy@575 76 public class SimpleElementVisitor7<R, P> extends SimpleElementVisitor6<R, P> {
darcy@575 77 /**
darcy@575 78 * Constructor for concrete subclasses; uses {@code null} for the
darcy@575 79 * default value.
darcy@575 80 */
darcy@575 81 protected SimpleElementVisitor7(){
darcy@575 82 super(null);
darcy@575 83 }
darcy@575 84
darcy@575 85 /**
darcy@575 86 * Constructor for concrete subclasses; uses the argument for the
darcy@575 87 * default value.
darcy@575 88 *
darcy@575 89 * @param defaultValue the value to assign to {@link #DEFAULT_VALUE}
darcy@575 90 */
darcy@575 91 protected SimpleElementVisitor7(R defaultValue){
darcy@575 92 super(defaultValue);
darcy@575 93 }
darcy@851 94
darcy@851 95 /**
darcy@851 96 * This implementation calls {@code defaultAction}.
darcy@851 97 *
darcy@851 98 * @param e {@inheritDoc}
darcy@851 99 * @param p {@inheritDoc}
darcy@851 100 * @return the result of {@code defaultAction}
darcy@851 101 */
darcy@851 102 @Override
darcy@851 103 public R visitVariable(VariableElement e, P p) {
darcy@851 104 return defaultAction(e, p);
darcy@851 105 }
darcy@575 106 }

mercurial