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

Tue, 05 Jul 2011 16:37:24 -0700

author
darcy
date
Tue, 05 Jul 2011 16:37:24 -0700
changeset 1054
111bbf1ad913
parent 798
4868a36f6fd8
child 1357
c75be5bc5283
permissions
-rw-r--r--

7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
Reviewed-by: jjg, mcimadamore

     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  */
    26 package javax.lang.model.util;
    29 import java.util.List;
    30 import javax.lang.model.element.*;
    32 import javax.lang.model.type.TypeMirror;
    33 import static javax.lang.model.SourceVersion.*;
    34 import javax.lang.model.SourceVersion;
    35 import javax.annotation.processing.SupportedSourceVersion;
    37 /**
    38  * A skeletal visitor for annotation values with default behavior
    39  * appropriate for the {@link SourceVersion#RELEASE_6 RELEASE_6}
    40  * source version.
    41  *
    42  * <p> <b>WARNING:</b> The {@code AnnotationValueVisitor} interface
    43  * implemented by this class may have methods added to it in the
    44  * future to accommodate new, currently unknown, language structures
    45  * added to future versions of the Java&trade; programming language.
    46  * Therefore, methods whose names begin with {@code "visit"} may be
    47  * added to this class in the future; to avoid incompatibilities,
    48  * classes which extend this class should not declare any instance
    49  * methods with names beginning with {@code "visit"}.
    50  *
    51  * <p>When such a new visit method is added, the default
    52  * implementation in this class will be to call the {@link
    53  * #visitUnknown visitUnknown} method.  A new abstract annotation
    54  * value visitor class will also be introduced to correspond to the
    55  * new language level; this visitor will have different default
    56  * behavior for the visit method in question.  When the new visitor is
    57  * introduced, all or portions of this visitor may be deprecated.
    58  *
    59  * @param <R> the return type of this visitor's methods
    60  * @param <P> the type of the additional parameter to this visitor's methods.
    61  *
    62  * @author Joseph D. Darcy
    63  * @author Scott Seligman
    64  * @author Peter von der Ah&eacute;
    65  *
    66  * @see AbstractAnnotationValueVisitor7
    67  * @see AbstractAnnotationValueVisitor8
    68  * @since 1.6
    69  */
    70 @SupportedSourceVersion(RELEASE_6)
    71 public abstract class AbstractAnnotationValueVisitor6<R, P>
    72     implements AnnotationValueVisitor<R, P> {
    74     /**
    75      * Constructor for concrete subclasses to call.
    76      */
    77     protected AbstractAnnotationValueVisitor6() {}
    79     /**
    80      * Visits an annotation value as if by passing itself to that
    81      * value's {@link AnnotationValue#accept accept}.  The invocation
    82      * {@code v.visit(av)} is equivalent to {@code av.accept(v, p)}.
    83      * @param av {@inheritDoc}
    84      * @param p  {@inheritDoc}
    85      */
    86     public final R visit(AnnotationValue av, P p) {
    87         return av.accept(this, p);
    88     }
    90     /**
    91      * Visits an annotation value as if by passing itself to that
    92      * value's {@link AnnotationValue#accept accept} method passing
    93      * {@code null} for the additional parameter.  The invocation
    94      * {@code v.visit(av)} is equivalent to {@code av.accept(v,
    95      * null)}.
    96      * @param av {@inheritDoc}
    97      */
    98     public final R visit(AnnotationValue av) {
    99         return av.accept(this, null);
   100     }
   102     /**
   103      * {@inheritDoc}
   104      *
   105      * <p>The default implementation of this method in {@code
   106      * AbstractAnnotationValueVisitor6} will always throw {@code
   107      * UnknownAnnotationValueException}.  This behavior is not
   108      * required of a subclass.
   109      *
   110      * @param av {@inheritDoc}
   111      * @param p  {@inheritDoc}
   112      */
   113     public R visitUnknown(AnnotationValue av, P p) {
   114         throw new UnknownAnnotationValueException(av, p);
   115     }
   116 }

mercurial