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

Print this page


   1 /*
   2  * Copyright (c) 2005, 2010, 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 static javax.lang.model.element.ElementKind.*;
  31 import javax.lang.model.SourceVersion;
  32 import static javax.lang.model.SourceVersion.*;
  33 
  34 
  35 /**
  36  * A simple visitor of program elements with default behavior
  37  * appropriate for the {@link SourceVersion#RELEASE_6 RELEASE_6}
  38  * source version.
  39  *
  40  * Visit methods corresponding to {@code RELEASE_6} language
  41  * constructs call {@link #defaultAction}, passing their arguments to
  42  * {@code defaultAction}'s corresponding parameters.



  43  *
  44  * <p> Methods in this class may be overridden subject to their
  45  * general contract.  Note that annotating methods in concrete
  46  * subclasses with {@link java.lang.Override @Override} will help
  47  * ensure that methods are overridden as intended.
  48  *
  49  * <p> <b>WARNING:</b> The {@code ElementVisitor} interface
  50  * implemented by this class may have methods added to it in the
  51  * future to accommodate new, currently unknown, language structures
  52  * added to future versions of the Java&trade; programming language.
  53  * Therefore, methods whose names begin with {@code "visit"} may be
  54  * added to this class in the future; to avoid incompatibilities,
  55  * classes which extend this class should not declare any instance
  56  * methods with names beginning with {@code "visit"}.
  57  *
  58  * <p>When such a new visit method is added, the default
  59  * implementation in this class will be to call the {@link
  60  * #visitUnknown visitUnknown} method.  A new simple element visitor
  61  * class will also be introduced to correspond to the new language
  62  * level; this visitor will have different default behavior for the


 120      * @param e {@inheritDoc}
 121      * @param p {@inheritDoc}
 122      * @return  the result of {@code defaultAction}
 123      */
 124     public R visitPackage(PackageElement e, P p) {
 125         return defaultAction(e, p);
 126     }
 127 
 128     /**
 129      * {@inheritDoc} This implementation calls {@code defaultAction}.
 130      *
 131      * @param e {@inheritDoc}
 132      * @param p {@inheritDoc}
 133      * @return  the result of {@code defaultAction}
 134      */
 135     public R visitType(TypeElement e, P p) {
 136         return defaultAction(e, p);
 137     }
 138 
 139     /**
 140      * {@inheritDoc} This implementation calls {@code defaultAction}.




 141      *
 142      * @param e {@inheritDoc}
 143      * @param p {@inheritDoc}
 144      * @return  the result of {@code defaultAction}
 145      */
 146     public R visitVariable(VariableElement e, P p) {

 147         return defaultAction(e, p);


 148     }
 149 
 150     /**
 151      * {@inheritDoc} This implementation calls {@code defaultAction}.
 152      *
 153      * @param e {@inheritDoc}
 154      * @param p {@inheritDoc}
 155      * @return  the result of {@code defaultAction}
 156      */
 157     public R visitExecutable(ExecutableElement e, P p) {
 158         return defaultAction(e, p);
 159     }
 160 
 161     /**
 162      * {@inheritDoc} This implementation calls {@code defaultAction}.
 163      *
 164      * @param e {@inheritDoc}
 165      * @param p {@inheritDoc}
 166      * @return  the result of {@code defaultAction}
 167      */
   1 /*
   2  * Copyright (c) 2005, 2011, 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 static javax.lang.model.element.ElementKind.*;
  31 import javax.lang.model.SourceVersion;
  32 import static javax.lang.model.SourceVersion.*;
  33 
  34 
  35 /**
  36  * A simple visitor of program elements with default behavior
  37  * appropriate for the {@link SourceVersion#RELEASE_6 RELEASE_6}
  38  * source version.
  39  *
  40  * Visit methods corresponding to {@code RELEASE_6} language
  41  * constructs call {@link #defaultAction defaultAction}, passing their
  42  * arguments to {@code defaultAction}'s corresponding parameters.
  43  *
  44  * For constructs introduced in {@code RELEASE_7} and later, {@code
  45  * visitUnknown} is called instead.
  46  *
  47  * <p> Methods in this class may be overridden subject to their
  48  * general contract.  Note that annotating methods in concrete
  49  * subclasses with {@link java.lang.Override @Override} will help
  50  * ensure that methods are overridden as intended.
  51  *
  52  * <p> <b>WARNING:</b> The {@code ElementVisitor} interface
  53  * implemented by this class may have methods added to it in the
  54  * future to accommodate new, currently unknown, language structures
  55  * added to future versions of the Java&trade; programming language.
  56  * Therefore, methods whose names begin with {@code "visit"} may be
  57  * added to this class in the future; to avoid incompatibilities,
  58  * classes which extend this class should not declare any instance
  59  * methods with names beginning with {@code "visit"}.
  60  *
  61  * <p>When such a new visit method is added, the default
  62  * implementation in this class will be to call the {@link
  63  * #visitUnknown visitUnknown} method.  A new simple element visitor
  64  * class will also be introduced to correspond to the new language
  65  * level; this visitor will have different default behavior for the


 123      * @param e {@inheritDoc}
 124      * @param p {@inheritDoc}
 125      * @return  the result of {@code defaultAction}
 126      */
 127     public R visitPackage(PackageElement e, P p) {
 128         return defaultAction(e, p);
 129     }
 130 
 131     /**
 132      * {@inheritDoc} This implementation calls {@code defaultAction}.
 133      *
 134      * @param e {@inheritDoc}
 135      * @param p {@inheritDoc}
 136      * @return  the result of {@code defaultAction}
 137      */
 138     public R visitType(TypeElement e, P p) {
 139         return defaultAction(e, p);
 140     }
 141 
 142     /**
 143      * {@inheritDoc}
 144      *
 145      * This implementation calls {@code defaultAction}, unless the
 146      * element is a {@code RESOURCE_VARIABLE} in which case {@code
 147      * visitUnknown} is called.
 148      *
 149      * @param e {@inheritDoc}
 150      * @param p {@inheritDoc}
 151      * @return  the result of {@code defaultAction} or {@code visitUnknown}
 152      */
 153     public R visitVariable(VariableElement e, P p) {
 154         if (e.getKind() != ElementKind.RESOURCE_VARIABLE)
 155             return defaultAction(e, p);
 156         else
 157             return visitUnknown(e, p);
 158     }
 159 
 160     /**
 161      * {@inheritDoc} This implementation calls {@code defaultAction}.
 162      *
 163      * @param e {@inheritDoc}
 164      * @param p {@inheritDoc}
 165      * @return  the result of {@code defaultAction}
 166      */
 167     public R visitExecutable(ExecutableElement e, P p) {
 168         return defaultAction(e, p);
 169     }
 170 
 171     /**
 172      * {@inheritDoc} This implementation calls {@code defaultAction}.
 173      *
 174      * @param e {@inheritDoc}
 175      * @param p {@inheritDoc}
 176      * @return  the result of {@code defaultAction}
 177      */