aoqi@0: /*
aoqi@0:  * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package javax.lang.model.util;
aoqi@0: 
aoqi@0: 
aoqi@0: import java.util.List;
aoqi@0: import javax.lang.model.element.*;
aoqi@0: 
aoqi@0: import javax.lang.model.type.TypeMirror;
aoqi@0: import static javax.lang.model.SourceVersion.*;
aoqi@0: import javax.lang.model.SourceVersion;
aoqi@0: import javax.annotation.processing.SupportedSourceVersion;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * A simple visitor for annotation values with default behavior
aoqi@0:  * appropriate for the {@link SourceVersion#RELEASE_6 RELEASE_6}
aoqi@0:  * source version.  Visit methods call {@link
aoqi@0:  * #defaultAction} passing their arguments to {@code defaultAction}'s
aoqi@0:  * corresponding parameters.
aoqi@0:  *
aoqi@0:  * <p> Methods in this class may be overridden subject to their
aoqi@0:  * general contract.  Note that annotating methods in concrete
aoqi@0:  * subclasses with {@link java.lang.Override @Override} will help
aoqi@0:  * ensure that methods are overridden as intended.
aoqi@0:  *
aoqi@0:  * <p> <b>WARNING:</b> The {@code AnnotationValueVisitor} interface
aoqi@0:  * implemented by this class may have methods added to it in the
aoqi@0:  * future to accommodate new, currently unknown, language structures
aoqi@0:  * added to future versions of the Java&trade; programming language.
aoqi@0:  * Therefore, methods whose names begin with {@code "visit"} may be
aoqi@0:  * added to this class in the future; to avoid incompatibilities,
aoqi@0:  * classes which extend this class should not declare any instance
aoqi@0:  * methods with names beginning with {@code "visit"}.
aoqi@0:  *
aoqi@0:  * <p>When such a new visit method is added, the default
aoqi@0:  * implementation in this class will be to call the {@link
aoqi@0:  * #visitUnknown visitUnknown} method.  A new simple annotation
aoqi@0:  * value visitor class will also be introduced to correspond to the
aoqi@0:  * new language level; this visitor will have different default
aoqi@0:  * behavior for the visit method in question.  When the new visitor is
aoqi@0:  * introduced, all or portions of this visitor may be deprecated.
aoqi@0:  *
aoqi@0:  * <p>Note that adding a default implementation of a new visit method
aoqi@0:  * in a visitor class will occur instead of adding a <em>default
aoqi@0:  * method</em> directly in the visitor interface since a Java SE 8
aoqi@0:  * language feature cannot be used to this version of the API since
aoqi@0:  * this version is required to be runnable on Java SE 7
aoqi@0:  * implementations.  Future versions of the API that are only required
aoqi@0:  * to run on Java SE 8 and later may take advantage of default methods
aoqi@0:  * in this situation.
aoqi@0:  *
aoqi@0:  * @param <R> the return type of this visitor's methods
aoqi@0:  * @param <P> the type of the additional parameter to this visitor's methods.
aoqi@0:  *
aoqi@0:  * @author Joseph D. Darcy
aoqi@0:  * @author Scott Seligman
aoqi@0:  * @author Peter von der Ah&eacute;
aoqi@0:  *
aoqi@0:  * @see SimpleAnnotationValueVisitor7
aoqi@0:  * @see SimpleAnnotationValueVisitor8
aoqi@0:  * @since 1.6
aoqi@0:  */
aoqi@0: @SupportedSourceVersion(RELEASE_6)
aoqi@0: public class SimpleAnnotationValueVisitor6<R, P>
aoqi@0:     extends AbstractAnnotationValueVisitor6<R, P> {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Default value to be returned; {@link #defaultAction
aoqi@0:      * defaultAction} returns this value unless the method is
aoqi@0:      * overridden.
aoqi@0:      */
aoqi@0:     protected final R DEFAULT_VALUE;
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Constructor for concrete subclasses; uses {@code null} for the
aoqi@0:      * default value.
aoqi@0:      */
aoqi@0:     protected SimpleAnnotationValueVisitor6() {
aoqi@0:         super();
aoqi@0:         DEFAULT_VALUE = null;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Constructor for concrete subclasses; uses the argument for the
aoqi@0:      * default value.
aoqi@0:      *
aoqi@0:      * @param defaultValue the value to assign to {@link #DEFAULT_VALUE}
aoqi@0:      */
aoqi@0:     protected SimpleAnnotationValueVisitor6(R defaultValue) {
aoqi@0:         super();
aoqi@0:         DEFAULT_VALUE = defaultValue;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * The default action for visit methods.  The implementation in
aoqi@0:      * this class just returns {@link #DEFAULT_VALUE}; subclasses will
aoqi@0:      * commonly override this method.
aoqi@0:      *
aoqi@0:      * @param o the value of the annotation
aoqi@0:      * @param p a visitor-specified parameter
aoqi@0:      * @return {@code DEFAULT_VALUE} unless overridden
aoqi@0:      */
aoqi@0:     protected R defaultAction(Object o, P p) {
aoqi@0:         return DEFAULT_VALUE;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0:      *
aoqi@0:      * @param b {@inheritDoc}
aoqi@0:      * @param p {@inheritDoc}
aoqi@0:      * @return  the result of {@code defaultAction}
aoqi@0:      */
aoqi@0:     public R visitBoolean(boolean b, P p) {
aoqi@0:         return defaultAction(b, p);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0:      *
aoqi@0:      * @param b {@inheritDoc}
aoqi@0:      * @param p {@inheritDoc}
aoqi@0:      * @return  the result of {@code defaultAction}
aoqi@0:      */
aoqi@0:     public R visitByte(byte b, P p) {
aoqi@0:         return defaultAction(b, p);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0:      *
aoqi@0:      * @param c {@inheritDoc}
aoqi@0:      * @param p {@inheritDoc}
aoqi@0:      * @return  the result of {@code defaultAction}
aoqi@0:      */
aoqi@0:     public R visitChar(char c, P p) {
aoqi@0:         return defaultAction(c, p);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0:      *
aoqi@0:      * @param d {@inheritDoc}
aoqi@0:      * @param p {@inheritDoc}
aoqi@0:      * @return  the result of {@code defaultAction}
aoqi@0:      */
aoqi@0:     public R visitDouble(double d, P p) {
aoqi@0:         return defaultAction(d, p);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0:      *
aoqi@0:      * @param f {@inheritDoc}
aoqi@0:      * @param p {@inheritDoc}
aoqi@0:      * @return  the result of {@code defaultAction}
aoqi@0:      */
aoqi@0:     public R visitFloat(float f, P p) {
aoqi@0:         return defaultAction(f, p);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0:      *
aoqi@0:      * @param i {@inheritDoc}
aoqi@0:      * @param p {@inheritDoc}
aoqi@0:      * @return  the result of {@code defaultAction}
aoqi@0:      */
aoqi@0:     public R visitInt(int i, P p) {
aoqi@0:         return defaultAction(i, p);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0:      *
aoqi@0:      * @param i {@inheritDoc}
aoqi@0:      * @param p {@inheritDoc}
aoqi@0:      * @return  the result of {@code defaultAction}
aoqi@0:      */
aoqi@0:     public R visitLong(long i, P p) {
aoqi@0:         return defaultAction(i, p);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0:      *
aoqi@0:      * @param s {@inheritDoc}
aoqi@0:      * @param p {@inheritDoc}
aoqi@0:      * @return  the result of {@code defaultAction}
aoqi@0:      */
aoqi@0:     public R visitShort(short s, P p) {
aoqi@0:         return defaultAction(s, p);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0:      *
aoqi@0:      * @param s {@inheritDoc}
aoqi@0:      * @param p {@inheritDoc}
aoqi@0:      * @return  the result of {@code defaultAction}
aoqi@0:      */
aoqi@0:     public R visitString(String s, P p) {
aoqi@0:         return defaultAction(s, p);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0:      *
aoqi@0:      * @param t {@inheritDoc}
aoqi@0:      * @param p {@inheritDoc}
aoqi@0:      * @return  the result of {@code defaultAction}
aoqi@0:      */
aoqi@0:     public R visitType(TypeMirror t, P p) {
aoqi@0:         return defaultAction(t, p);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0:      *
aoqi@0:      * @param c {@inheritDoc}
aoqi@0:      * @param p {@inheritDoc}
aoqi@0:      * @return  the result of {@code defaultAction}
aoqi@0:      */
aoqi@0:     public R visitEnumConstant(VariableElement c, P p) {
aoqi@0:         return defaultAction(c, p);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0:      *
aoqi@0:      * @param a {@inheritDoc}
aoqi@0:      * @param p {@inheritDoc}
aoqi@0:      * @return  the result of {@code defaultAction}
aoqi@0:      */
aoqi@0:     public R visitAnnotation(AnnotationMirror a, P p) {
aoqi@0:         return defaultAction(a, p);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc} This implementation calls {@code defaultAction}.
aoqi@0:      *
aoqi@0:      * @param vals {@inheritDoc}
aoqi@0:      * @param p {@inheritDoc}
aoqi@0:      * @return  the result of {@code defaultAction}
aoqi@0:      */
aoqi@0:     public R visitArray(List<? extends AnnotationValue> vals, P p) {
aoqi@0:         return defaultAction(vals, p);
aoqi@0:     }
aoqi@0: }