langtools/src/share/classes/javax/lang/model/util/AbstractAnnotationValueVisitor6.java
author darcy
Thu, 17 Jul 2014 09:47:25 -0700
changeset 25690 b1dac768ab79
parent 22448 a85fbad9d687
permissions -rw-r--r--
8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9 Reviewed-by: jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     1
/*
25690
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 22448
diff changeset
     2
 * Copyright (c) 2005, 2014, Oracle and/or its affiliates. All rights reserved.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load
duke
parents:
diff changeset
     4
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
10
06bc494ca11e Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    10
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
06bc494ca11e Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
06bc494ca11e Initial load
duke
parents:
diff changeset
    16
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load
duke
parents:
diff changeset
    20
 *
5520
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices
ohair
parents: 10
diff changeset
    23
 * questions.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    24
 */
06bc494ca11e Initial load
duke
parents:
diff changeset
    25
06bc494ca11e Initial load
duke
parents:
diff changeset
    26
package javax.lang.model.util;
06bc494ca11e Initial load
duke
parents:
diff changeset
    27
06bc494ca11e Initial load
duke
parents:
diff changeset
    28
06bc494ca11e Initial load
duke
parents:
diff changeset
    29
import javax.lang.model.element.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    30
06bc494ca11e Initial load
duke
parents:
diff changeset
    31
import static javax.lang.model.SourceVersion.*;
06bc494ca11e Initial load
duke
parents:
diff changeset
    32
import javax.lang.model.SourceVersion;
06bc494ca11e Initial load
duke
parents:
diff changeset
    33
import javax.annotation.processing.SupportedSourceVersion;
06bc494ca11e Initial load
duke
parents:
diff changeset
    34
06bc494ca11e Initial load
duke
parents:
diff changeset
    35
/**
06bc494ca11e Initial load
duke
parents:
diff changeset
    36
 * A skeletal visitor for annotation values with default behavior
06bc494ca11e Initial load
duke
parents:
diff changeset
    37
 * appropriate for the {@link SourceVersion#RELEASE_6 RELEASE_6}
06bc494ca11e Initial load
duke
parents:
diff changeset
    38
 * source version.
06bc494ca11e Initial load
duke
parents:
diff changeset
    39
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    40
 * <p> <b>WARNING:</b> The {@code AnnotationValueVisitor} interface
06bc494ca11e Initial load
duke
parents:
diff changeset
    41
 * implemented by this class may have methods added to it in the
06bc494ca11e Initial load
duke
parents:
diff changeset
    42
 * future to accommodate new, currently unknown, language structures
06bc494ca11e Initial load
duke
parents:
diff changeset
    43
 * added to future versions of the Java&trade; programming language.
06bc494ca11e Initial load
duke
parents:
diff changeset
    44
 * Therefore, methods whose names begin with {@code "visit"} may be
06bc494ca11e Initial load
duke
parents:
diff changeset
    45
 * added to this class in the future; to avoid incompatibilities,
06bc494ca11e Initial load
duke
parents:
diff changeset
    46
 * classes which extend this class should not declare any instance
06bc494ca11e Initial load
duke
parents:
diff changeset
    47
 * methods with names beginning with {@code "visit"}.
06bc494ca11e Initial load
duke
parents:
diff changeset
    48
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    49
 * <p>When such a new visit method is added, the default
06bc494ca11e Initial load
duke
parents:
diff changeset
    50
 * implementation in this class will be to call the {@link
06bc494ca11e Initial load
duke
parents:
diff changeset
    51
 * #visitUnknown visitUnknown} method.  A new abstract annotation
06bc494ca11e Initial load
duke
parents:
diff changeset
    52
 * value visitor class will also be introduced to correspond to the
06bc494ca11e Initial load
duke
parents:
diff changeset
    53
 * new language level; this visitor will have different default
06bc494ca11e Initial load
duke
parents:
diff changeset
    54
 * behavior for the visit method in question.  When the new visitor is
06bc494ca11e Initial load
duke
parents:
diff changeset
    55
 * introduced, all or portions of this visitor may be deprecated.
06bc494ca11e Initial load
duke
parents:
diff changeset
    56
 *
15386
92bc08d96f0c 8006264: Add explanation of why default methods cannot be used in JDK 8 javax.lang.model
darcy
parents: 14258
diff changeset
    57
 * <p>Note that adding a default implementation of a new visit method
92bc08d96f0c 8006264: Add explanation of why default methods cannot be used in JDK 8 javax.lang.model
darcy
parents: 14258
diff changeset
    58
 * in a visitor class will occur instead of adding a <em>default
92bc08d96f0c 8006264: Add explanation of why default methods cannot be used in JDK 8 javax.lang.model
darcy
parents: 14258
diff changeset
    59
 * method</em> directly in the visitor interface since a Java SE 8
92bc08d96f0c 8006264: Add explanation of why default methods cannot be used in JDK 8 javax.lang.model
darcy
parents: 14258
diff changeset
    60
 * language feature cannot be used to this version of the API since
92bc08d96f0c 8006264: Add explanation of why default methods cannot be used in JDK 8 javax.lang.model
darcy
parents: 14258
diff changeset
    61
 * this version is required to be runnable on Java SE 7
92bc08d96f0c 8006264: Add explanation of why default methods cannot be used in JDK 8 javax.lang.model
darcy
parents: 14258
diff changeset
    62
 * implementations.  Future versions of the API that are only required
92bc08d96f0c 8006264: Add explanation of why default methods cannot be used in JDK 8 javax.lang.model
darcy
parents: 14258
diff changeset
    63
 * to run on Java SE 8 and later may take advantage of default methods
92bc08d96f0c 8006264: Add explanation of why default methods cannot be used in JDK 8 javax.lang.model
darcy
parents: 14258
diff changeset
    64
 * in this situation.
92bc08d96f0c 8006264: Add explanation of why default methods cannot be used in JDK 8 javax.lang.model
darcy
parents: 14258
diff changeset
    65
 *
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    66
 * @param <R> the return type of this visitor's methods
06bc494ca11e Initial load
duke
parents:
diff changeset
    67
 * @param <P> the type of the additional parameter to this visitor's methods.
06bc494ca11e Initial load
duke
parents:
diff changeset
    68
 *
06bc494ca11e Initial load
duke
parents:
diff changeset
    69
 * @author Joseph D. Darcy
06bc494ca11e Initial load
duke
parents:
diff changeset
    70
 * @author Scott Seligman
06bc494ca11e Initial load
duke
parents:
diff changeset
    71
 * @author Peter von der Ah&eacute;
5841
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents: 5520
diff changeset
    72
 *
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents: 5520
diff changeset
    73
 * @see AbstractAnnotationValueVisitor7
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents: 7681
diff changeset
    74
 * @see AbstractAnnotationValueVisitor8
25690
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 22448
diff changeset
    75
 * @see AbstractAnnotationValueVisitor9
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    76
 * @since 1.6
25690
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 22448
diff changeset
    77
 * @deprecated Release 6 is obsolete; update to a visitor for a newer
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 22448
diff changeset
    78
 * release level.
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    79
 */
25690
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 22448
diff changeset
    80
@Deprecated
10
06bc494ca11e Initial load
duke
parents:
diff changeset
    81
@SupportedSourceVersion(RELEASE_6)
06bc494ca11e Initial load
duke
parents:
diff changeset
    82
public abstract class AbstractAnnotationValueVisitor6<R, P>
06bc494ca11e Initial load
duke
parents:
diff changeset
    83
    implements AnnotationValueVisitor<R, P> {
06bc494ca11e Initial load
duke
parents:
diff changeset
    84
06bc494ca11e Initial load
duke
parents:
diff changeset
    85
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    86
     * Constructor for concrete subclasses to call.
06bc494ca11e Initial load
duke
parents:
diff changeset
    87
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    88
    protected AbstractAnnotationValueVisitor6() {}
06bc494ca11e Initial load
duke
parents:
diff changeset
    89
06bc494ca11e Initial load
duke
parents:
diff changeset
    90
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
    91
     * Visits an annotation value as if by passing itself to that
06bc494ca11e Initial load
duke
parents:
diff changeset
    92
     * value's {@link AnnotationValue#accept accept}.  The invocation
06bc494ca11e Initial load
duke
parents:
diff changeset
    93
     * {@code v.visit(av)} is equivalent to {@code av.accept(v, p)}.
06bc494ca11e Initial load
duke
parents:
diff changeset
    94
     * @param av {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    95
     * @param p  {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
    96
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
    97
    public final R visit(AnnotationValue av, P p) {
06bc494ca11e Initial load
duke
parents:
diff changeset
    98
        return av.accept(this, p);
06bc494ca11e Initial load
duke
parents:
diff changeset
    99
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   100
06bc494ca11e Initial load
duke
parents:
diff changeset
   101
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   102
     * Visits an annotation value as if by passing itself to that
06bc494ca11e Initial load
duke
parents:
diff changeset
   103
     * value's {@link AnnotationValue#accept accept} method passing
06bc494ca11e Initial load
duke
parents:
diff changeset
   104
     * {@code null} for the additional parameter.  The invocation
06bc494ca11e Initial load
duke
parents:
diff changeset
   105
     * {@code v.visit(av)} is equivalent to {@code av.accept(v,
06bc494ca11e Initial load
duke
parents:
diff changeset
   106
     * null)}.
06bc494ca11e Initial load
duke
parents:
diff changeset
   107
     * @param av {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   108
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   109
    public final R visit(AnnotationValue av) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   110
        return av.accept(this, null);
06bc494ca11e Initial load
duke
parents:
diff changeset
   111
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   112
06bc494ca11e Initial load
duke
parents:
diff changeset
   113
    /**
06bc494ca11e Initial load
duke
parents:
diff changeset
   114
     * {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   115
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
   116
     * <p>The default implementation of this method in {@code
06bc494ca11e Initial load
duke
parents:
diff changeset
   117
     * AbstractAnnotationValueVisitor6} will always throw {@code
06bc494ca11e Initial load
duke
parents:
diff changeset
   118
     * UnknownAnnotationValueException}.  This behavior is not
06bc494ca11e Initial load
duke
parents:
diff changeset
   119
     * required of a subclass.
06bc494ca11e Initial load
duke
parents:
diff changeset
   120
     *
06bc494ca11e Initial load
duke
parents:
diff changeset
   121
     * @param av {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   122
     * @param p  {@inheritDoc}
06bc494ca11e Initial load
duke
parents:
diff changeset
   123
     */
06bc494ca11e Initial load
duke
parents:
diff changeset
   124
    public R visitUnknown(AnnotationValue av, P p) {
06bc494ca11e Initial load
duke
parents:
diff changeset
   125
        throw new UnknownAnnotationValueException(av, p);
06bc494ca11e Initial load
duke
parents:
diff changeset
   126
    }
06bc494ca11e Initial load
duke
parents:
diff changeset
   127
}