duke@1: /*
darcy@851:  * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package javax.lang.model.util;
duke@1: 
duke@1: import javax.lang.model.element.*;
duke@1: import static javax.lang.model.element.ElementKind.*;
duke@1: import javax.annotation.processing.SupportedSourceVersion;
duke@1: import static javax.lang.model.SourceVersion.*;
duke@1: import javax.lang.model.SourceVersion;
duke@1: 
duke@1: 
duke@1: /**
duke@1:  * A visitor of program elements based on their {@linkplain
duke@1:  * ElementKind kind} with default behavior appropriate for the {@link
duke@1:  * SourceVersion#RELEASE_6 RELEASE_6} source version.  For {@linkplain
duke@1:  * Element elements} <tt><i>XYZ</i></tt> that may have more than one
duke@1:  * kind, the <tt>visit<i>XYZ</i></tt> methods in this class delegate
duke@1:  * to the <tt>visit<i>XYZKind</i></tt> method corresponding to the
duke@1:  * first argument's kind.  The <tt>visit<i>XYZKind</i></tt> methods
duke@1:  * call {@link #defaultAction defaultAction}, passing their arguments
duke@1:  * to {@code defaultAction}'s corresponding parameters.
duke@1:  *
duke@1:  * <p> Methods in this class may be overridden subject to their
duke@1:  * general contract.  Note that annotating methods in concrete
duke@1:  * subclasses with {@link java.lang.Override @Override} will help
duke@1:  * ensure that methods are overridden as intended.
duke@1:  *
duke@1:  * <p> <b>WARNING:</b> The {@code ElementVisitor} interface
duke@1:  * implemented by this class may have methods added to it or the
duke@1:  * {@code ElementKind} {@code enum} used in this case may have
duke@1:  * constants added to it in the future to accommodate new, currently
duke@1:  * unknown, language structures added to future versions of the
duke@1:  * Java&trade; programming language.  Therefore, methods whose names
duke@1:  * begin with {@code "visit"} may be added to this class in the
duke@1:  * future; to avoid incompatibilities, classes which extend this class
duke@1:  * should not declare any instance methods with names beginning with
duke@1:  * {@code "visit"}.
duke@1:  *
duke@1:  * <p>When such a new visit method is added, the default
duke@1:  * implementation in this class will be to call the {@link
duke@1:  * #visitUnknown visitUnknown} method.  A new abstract element kind
duke@1:  * visitor class will also be introduced to correspond to the new
duke@1:  * language level; this visitor will have different default behavior
duke@1:  * for the visit method in question.  When the new visitor is
duke@1:  * introduced, all or portions of this visitor may be deprecated.
duke@1:  *
duke@1:  * @param <R> the return type of this visitor's methods.  Use {@link
duke@1:  *            Void} for visitors that do not need to return results.
duke@1:  * @param <P> the type of the additional parameter to this visitor's
duke@1:  *            methods.  Use {@code Void} for visitors that do not need an
duke@1:  *            additional parameter.
duke@1:  *
duke@1:  * @author Joseph D. Darcy
duke@1:  * @author Scott Seligman
duke@1:  * @author Peter von der Ah&eacute;
darcy@575:  *
darcy@575:  * @see ElementKindVisitor7
duke@1:  * @since 1.6
duke@1:  */
duke@1: @SupportedSourceVersion(RELEASE_6)
duke@1: public class ElementKindVisitor6<R, P>
duke@1:                   extends SimpleElementVisitor6<R, P> {
duke@1:     /**
duke@1:      * Constructor for concrete subclasses; uses {@code null} for the
duke@1:      * default value.
duke@1:      */
duke@1:     protected ElementKindVisitor6() {
duke@1:         super(null);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Constructor for concrete subclasses; uses the argument for the
duke@1:      * default value.
duke@1:      *
duke@1:      * @param defaultValue the value to assign to {@link #DEFAULT_VALUE}
duke@1:      */
duke@1:     protected ElementKindVisitor6(R defaultValue) {
duke@1:         super(defaultValue);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      *
duke@1:      * The element argument has kind {@code PACKAGE}.
duke@1:      *
duke@1:      * @param e {@inheritDoc}
duke@1:      * @param p {@inheritDoc}
duke@1:      * @return  {@inheritDoc}
duke@1:      */
duke@1:     @Override
duke@1:     public R visitPackage(PackageElement e, P p) {
duke@1:         assert e.getKind() == PACKAGE: "Bad kind on PackageElement";
duke@1:         return defaultAction(e, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Visits a type element, dispatching to the visit method for the
duke@1:      * specific {@linkplain ElementKind kind} of type, {@code
duke@1:      * ANNOTATION_TYPE}, {@code CLASS}, {@code ENUM}, or {@code
duke@1:      * INTERFACE}.
duke@1:      *
duke@1:      * @param e {@inheritDoc}
duke@1:      * @param p {@inheritDoc}
duke@1:      * @return  the result of the kind-specific visit method
duke@1:      */
duke@1:     @Override
duke@1:     public R visitType(TypeElement e, P p) {
duke@1:         ElementKind k = e.getKind();
duke@1:         switch(k) {
duke@1:         case ANNOTATION_TYPE:
duke@1:             return visitTypeAsAnnotationType(e, p);
duke@1: 
duke@1:         case CLASS:
duke@1:             return visitTypeAsClass(e, p);
duke@1: 
duke@1:         case ENUM:
duke@1:             return visitTypeAsEnum(e, p);
duke@1: 
duke@1:         case INTERFACE:
duke@1:             return visitTypeAsInterface(e, p);
duke@1: 
duke@1:         default:
duke@1:             throw new AssertionError("Bad kind " + k + " for TypeElement" + e);
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Visits an {@code ANNOTATION_TYPE} type element by calling
duke@1:      * {@code defaultAction}.
duke@1:      *
duke@1:      * @param e the element to visit
duke@1:      * @param p a visitor-specified parameter
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitTypeAsAnnotationType(TypeElement e, P p) {
duke@1:         return defaultAction(e, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Visits a {@code CLASS} type element by calling {@code
duke@1:      * defaultAction}.
duke@1:      *
duke@1:      * @param e the element to visit
duke@1:      * @param p a visitor-specified parameter
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitTypeAsClass(TypeElement e, P p) {
duke@1:         return defaultAction(e, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Visits an {@code ENUM} type element by calling {@code
duke@1:      * defaultAction}.
duke@1:      *
duke@1:      * @param e the element to visit
duke@1:      * @param p a visitor-specified parameter
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitTypeAsEnum(TypeElement e, P p) {
duke@1:         return defaultAction(e, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Visits an {@code INTERFACE} type element by calling {@code
duke@1:      * defaultAction}.
duke@1:      *.
duke@1:      * @param e the element to visit
duke@1:      * @param p a visitor-specified parameter
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitTypeAsInterface(TypeElement e, P p) {
duke@1:         return defaultAction(e, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Visits a variable element, dispatching to the visit method for
duke@1:      * the specific {@linkplain ElementKind kind} of variable, {@code
duke@1:      * ENUM_CONSTANT}, {@code EXCEPTION_PARAMETER}, {@code FIELD},
darcy@851:      * {@code LOCAL_VARIABLE}, {@code PARAMETER}, or {@code RESOURCE_VARIABLE}.
darcy@851:      *
duke@1:      * @param e {@inheritDoc}
duke@1:      * @param p {@inheritDoc}
duke@1:      * @return  the result of the kind-specific visit method
duke@1:      */
duke@1:     @Override
duke@1:     public R visitVariable(VariableElement e, P p) {
duke@1:         ElementKind k = e.getKind();
duke@1:         switch(k) {
duke@1:         case ENUM_CONSTANT:
duke@1:             return visitVariableAsEnumConstant(e, p);
duke@1: 
duke@1:         case EXCEPTION_PARAMETER:
duke@1:             return visitVariableAsExceptionParameter(e, p);
duke@1: 
duke@1:         case FIELD:
duke@1:             return visitVariableAsField(e, p);
duke@1: 
duke@1:         case LOCAL_VARIABLE:
duke@1:             return visitVariableAsLocalVariable(e, p);
duke@1: 
duke@1:         case PARAMETER:
duke@1:             return visitVariableAsParameter(e, p);
duke@1: 
darcy@851:         case RESOURCE_VARIABLE:
darcy@851:             return visitVariableAsResourceVariable(e, p);
darcy@851: 
duke@1:         default:
duke@1:             throw new AssertionError("Bad kind " + k + " for VariableElement" + e);
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Visits an {@code ENUM_CONSTANT} variable element by calling
duke@1:      * {@code defaultAction}.
duke@1:      *
duke@1:      * @param e the element to visit
duke@1:      * @param p a visitor-specified parameter
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitVariableAsEnumConstant(VariableElement e, P p) {
duke@1:         return defaultAction(e, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Visits an {@code EXCEPTION_PARAMETER} variable element by calling
duke@1:      * {@code defaultAction}.
duke@1:      *
duke@1:      * @param e the element to visit
duke@1:      * @param p a visitor-specified parameter
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitVariableAsExceptionParameter(VariableElement e, P p) {
duke@1:         return defaultAction(e, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Visits a {@code FIELD} variable element by calling
duke@1:      * {@code defaultAction}.
duke@1:      *
duke@1:      * @param e the element to visit
duke@1:      * @param p a visitor-specified parameter
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitVariableAsField(VariableElement e, P p) {
duke@1:         return defaultAction(e, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Visits a {@code LOCAL_VARIABLE} variable element by calling
duke@1:      * {@code defaultAction}.
duke@1:      *
duke@1:      * @param e the element to visit
duke@1:      * @param p a visitor-specified parameter
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitVariableAsLocalVariable(VariableElement e, P p) {
duke@1:         return defaultAction(e, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Visits a {@code PARAMETER} variable element by calling
duke@1:      * {@code defaultAction}.
duke@1:      *
duke@1:      * @param e the element to visit
duke@1:      * @param p a visitor-specified parameter
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitVariableAsParameter(VariableElement e, P p) {
duke@1:         return defaultAction(e, p);
duke@1:     }
duke@1: 
duke@1:     /**
darcy@851:      * Visits a {@code RESOURCE_VARIABLE} variable element by calling
darcy@851:      * {@code visitUnknown}.
darcy@851:      *
darcy@851:      * @param e the element to visit
darcy@851:      * @param p a visitor-specified parameter
darcy@851:      * @return  the result of {@code visitUnknown}
darcy@851:      *
darcy@851:      * @since 1.7
darcy@851:      */
darcy@851:     public R visitVariableAsResourceVariable(VariableElement e, P p) {
darcy@851:         return visitUnknown(e, p);
darcy@851:     }
darcy@851: 
darcy@851:     /**
duke@1:      * Visits an executable element, dispatching to the visit method
duke@1:      * for the specific {@linkplain ElementKind kind} of executable,
duke@1:      * {@code CONSTRUCTOR}, {@code INSTANCE_INIT}, {@code METHOD}, or
duke@1:      * {@code STATIC_INIT}.
duke@1:      *
duke@1:      * @param e {@inheritDoc}
duke@1:      * @param p {@inheritDoc}
duke@1:      * @return  the result of the kind-specific visit method
duke@1:      */
duke@1:     @Override
duke@1:     public R visitExecutable(ExecutableElement e, P p) {
duke@1:         ElementKind k = e.getKind();
duke@1:         switch(k) {
duke@1:         case CONSTRUCTOR:
duke@1:             return visitExecutableAsConstructor(e, p);
duke@1: 
duke@1:         case INSTANCE_INIT:
duke@1:             return visitExecutableAsInstanceInit(e, p);
duke@1: 
duke@1:         case METHOD:
duke@1:             return visitExecutableAsMethod(e, p);
duke@1: 
duke@1:         case STATIC_INIT:
duke@1:             return visitExecutableAsStaticInit(e, p);
duke@1: 
duke@1:         default:
duke@1:             throw new AssertionError("Bad kind " + k + " for ExecutableElement" + e);
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Visits a {@code CONSTRUCTOR} executable element by calling
duke@1:      * {@code defaultAction}.
duke@1:      *
duke@1:      * @param e the element to visit
duke@1:      * @param p a visitor-specified parameter
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitExecutableAsConstructor(ExecutableElement e, P p) {
duke@1:         return defaultAction(e, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Visits an {@code INSTANCE_INIT} executable element by calling
duke@1:      * {@code defaultAction}.
duke@1:      *
duke@1:      * @param e the element to visit
duke@1:      * @param p a visitor-specified parameter
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitExecutableAsInstanceInit(ExecutableElement e, P p) {
duke@1:         return defaultAction(e, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Visits a {@code METHOD} executable element by calling
duke@1:      * {@code defaultAction}.
duke@1:      *
duke@1:      * @param e the element to visit
duke@1:      * @param p a visitor-specified parameter
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitExecutableAsMethod(ExecutableElement e, P p) {
duke@1:         return defaultAction(e, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Visits a {@code STATIC_INIT} executable element by calling
duke@1:      * {@code defaultAction}.
duke@1:      *
duke@1:      * @param e the element to visit
duke@1:      * @param p a visitor-specified parameter
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitExecutableAsStaticInit(ExecutableElement e, P p) {
duke@1:         return defaultAction(e, p);
duke@1:     }
duke@1: 
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      *
duke@1:      * The element argument has kind {@code TYPE_PARAMETER}.
duke@1:      *
duke@1:      * @param e {@inheritDoc}
duke@1:      * @param p {@inheritDoc}
duke@1:      * @return  {@inheritDoc}
duke@1:      */
duke@1:     @Override
duke@1:     public R visitTypeParameter(TypeParameterElement e, P p) {
duke@1:         assert e.getKind() == TYPE_PARAMETER: "Bad kind on TypeParameterElement";
duke@1:         return defaultAction(e, p);
duke@1:     }
duke@1: }