duke@1: /*
ohair@798:  * Copyright (c) 2005, 2010, 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.type.*;
duke@1: import javax.annotation.processing.SupportedSourceVersion;
duke@1: import javax.lang.model.SourceVersion;
duke@1: import static javax.lang.model.SourceVersion.*;
duke@1: 
duke@1: 
duke@1: /**
duke@1:  * A simple visitor of types with default behavior appropriate for the
duke@1:  * {@link SourceVersion#RELEASE_6 RELEASE_6} source version.
duke@1:  *
duke@1:  * Visit methods corresponding to {@code RELEASE_6} language
duke@1:  * constructs call {@link #defaultAction}, passing their arguments to
duke@1:  * {@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 TypeVisitor} interface implemented
duke@1:  * by this class may have methods added to it in the future to
duke@1:  * accommodate new, currently unknown, language structures added to
duke@1:  * future versions of the Java&trade; programming language.
duke@1:  * Therefore, methods whose names begin with {@code "visit"} may be
duke@1:  * added to this class in the future; to avoid incompatibilities,
duke@1:  * classes which extend this class should not declare any instance
duke@1:  * methods with names beginning with {@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 simple type visitor
duke@1:  * class will also be introduced to correspond to the new language
duke@1:  * level; this visitor will have different default behavior for the
duke@1:  * visit method in question.  When the new visitor is introduced, all
duke@1:  * 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 SimpleTypeVisitor7
duke@1:  * @since 1.6
duke@1:  */
duke@1: @SupportedSourceVersion(RELEASE_6)
duke@1: public class SimpleTypeVisitor6<R, P> extends AbstractTypeVisitor6<R, P> {
duke@1:     /**
duke@1:      * Default value to be returned; {@link #defaultAction
duke@1:      * defaultAction} returns this value unless the method is
duke@1:      * overridden.
duke@1:      */
duke@1:     protected final R DEFAULT_VALUE;
duke@1: 
duke@1:     /**
duke@1:      * Constructor for concrete subclasses; uses {@code null} for the
duke@1:      * default value.
duke@1:      */
duke@1:     protected SimpleTypeVisitor6(){
duke@1:         DEFAULT_VALUE = 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 SimpleTypeVisitor6(R defaultValue){
duke@1:         DEFAULT_VALUE = defaultValue;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * The default action for visit methods.  The implementation in
duke@1:      * this class just returns {@link #DEFAULT_VALUE}; subclasses will
duke@1:      * commonly override this method.
duke@1:      */
duke@1:     protected R defaultAction(TypeMirror e, P p) {
duke@1:         return DEFAULT_VALUE;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc} This implementation calls {@code defaultAction}.
duke@1:      *
duke@1:      * @param t {@inheritDoc}
duke@1:      * @param p {@inheritDoc}
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitPrimitive(PrimitiveType t, P p) {
duke@1:         return defaultAction(t, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc} This implementation calls {@code defaultAction}.
duke@1:      *
duke@1:      * @param t {@inheritDoc}
duke@1:      * @param p {@inheritDoc}
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitNull(NullType t, P p){
duke@1:         return defaultAction(t, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc} This implementation calls {@code defaultAction}.
duke@1:      *
duke@1:      * @param t {@inheritDoc}
duke@1:      * @param p {@inheritDoc}
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitArray(ArrayType t, P p){
duke@1:         return defaultAction(t, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc} This implementation calls {@code defaultAction}.
duke@1:      *
duke@1:      * @param t {@inheritDoc}
duke@1:      * @param p {@inheritDoc}
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitDeclared(DeclaredType t, P p){
duke@1:         return defaultAction(t, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc} This implementation calls {@code defaultAction}.
duke@1:      *
duke@1:      * @param t {@inheritDoc}
duke@1:      * @param p {@inheritDoc}
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitError(ErrorType t, P p){
duke@1:         return defaultAction(t, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc} This implementation calls {@code defaultAction}.
duke@1:      *
duke@1:      * @param t {@inheritDoc}
duke@1:      * @param p {@inheritDoc}
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitTypeVariable(TypeVariable t, P p){
duke@1:         return defaultAction(t, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc} This implementation calls {@code defaultAction}.
duke@1:      *
duke@1:      * @param t {@inheritDoc}
duke@1:      * @param p {@inheritDoc}
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitWildcard(WildcardType t, P p){
duke@1:         return defaultAction(t, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc} This implementation calls {@code defaultAction}.
duke@1:      *
duke@1:      * @param t {@inheritDoc}
duke@1:      * @param p {@inheritDoc}
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitExecutable(ExecutableType t, P p) {
duke@1:         return defaultAction(t, p);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc} This implementation calls {@code defaultAction}.
duke@1:      *
duke@1:      * @param t {@inheritDoc}
duke@1:      * @param p {@inheritDoc}
duke@1:      * @return  the result of {@code defaultAction}
duke@1:      */
duke@1:     public R visitNoType(NoType t, P p){
duke@1:         return defaultAction(t, p);
duke@1:     }
duke@1: }