src/java.compiler/share/classes/javax/lang/model/util/ElementKindVisitor8.java
author pliden
Fri, 23 Aug 2019 08:48:27 +0200
changeset 57852 92f994585e25
parent 50964 225b61293064
permissions -rw-r--r--
8229127: Make some methods in the allocation path non-virtual Reviewed-by: eosterlund
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     1
/*
50964
225b61293064 8173606: Deprecate constructors of 7-era visitors
darcy
parents: 47216
diff changeset
     2
 * Copyright (c) 2011, 2018, Oracle and/or its affiliates. All rights reserved.
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     4
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    10
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    15
 * accompanied this code).
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    16
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    20
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    23
 * questions.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    24
 */
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    25
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    26
package javax.lang.model.util;
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    27
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    28
import javax.lang.model.element.*;
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    29
import javax.annotation.processing.SupportedSourceVersion;
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    30
import static javax.lang.model.SourceVersion.*;
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    31
import javax.lang.model.SourceVersion;
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    32
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    33
/**
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    34
 * A visitor of program elements based on their {@linkplain
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    35
 * ElementKind kind} with default behavior appropriate for the {@link
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    36
 * SourceVersion#RELEASE_8 RELEASE_8} source version.  For {@linkplain
43147
823bfbf9e914 8172531: Correct misstatements in javax.lang.model visitor documentation
darcy
parents: 43133
diff changeset
    37
 * Element elements} <code><i>Xyz</i></code> that may have more than one
823bfbf9e914 8172531: Correct misstatements in javax.lang.model visitor documentation
darcy
parents: 43133
diff changeset
    38
 * kind, the <code>visit<i>Xyz</i></code> methods in this class delegate
823bfbf9e914 8172531: Correct misstatements in javax.lang.model visitor documentation
darcy
parents: 43133
diff changeset
    39
 * to the <code>visit<i>Xyz</i>As<i>Kind</i></code> method corresponding to the
823bfbf9e914 8172531: Correct misstatements in javax.lang.model visitor documentation
darcy
parents: 43133
diff changeset
    40
 * first argument's kind.  The <code>visit<i>Xyz</i>As<i>Kind</i></code> methods
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    41
 * call {@link #defaultAction defaultAction}, passing their arguments
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    42
 * to {@code defaultAction}'s corresponding parameters.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    43
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    44
 * <p> Methods in this class may be overridden subject to their
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    45
 * general contract.  Note that annotating methods in concrete
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    46
 * subclasses with {@link java.lang.Override @Override} will help
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    47
 * ensure that methods are overridden as intended.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    48
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    49
 * <p> <b>WARNING:</b> The {@code ElementVisitor} interface
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    50
 * implemented by this class may have methods added to it or the
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    51
 * {@code ElementKind} {@code enum} used in this case may have
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    52
 * constants added to it in the future to accommodate new, currently
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    53
 * unknown, language structures added to future versions of the
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    54
 * Java&trade; programming language.  Therefore, methods whose names
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    55
 * begin with {@code "visit"} may be added to this class in the
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    56
 * future; to avoid incompatibilities, classes which extend this class
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    57
 * should not declare any instance methods with names beginning with
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    58
 * {@code "visit"}.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    59
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    60
 * <p>When such a new visit method is added, the default
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    61
 * implementation in this class will be to call the {@link
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    62
 * #visitUnknown visitUnknown} method.  A new abstract element kind
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    63
 * visitor class will also be introduced to correspond to the new
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    64
 * language level; this visitor will have different default behavior
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    65
 * for the visit method in question.  When the new visitor is
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    66
 * introduced, all or portions of this visitor may be deprecated.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    67
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    68
 * @param <R> the return type of this visitor's methods.  Use {@link
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    69
 *            Void} for visitors that do not need to return results.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    70
 * @param <P> the type of the additional parameter to this visitor's
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    71
 *            methods.  Use {@code Void} for visitors that do not need an
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    72
 *            additional parameter.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    73
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    74
 * @see ElementKindVisitor6
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    75
 * @see ElementKindVisitor7
25690
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 15386
diff changeset
    76
 * @see ElementKindVisitor9
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    77
 * @since 1.8
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    78
 */
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    79
@SupportedSourceVersion(RELEASE_8)
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    80
public class ElementKindVisitor8<R, P> extends ElementKindVisitor7<R, P> {
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    81
    /**
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    82
     * Constructor for concrete subclasses; uses {@code null} for the
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    83
     * default value.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    84
     */
50964
225b61293064 8173606: Deprecate constructors of 7-era visitors
darcy
parents: 47216
diff changeset
    85
    @SuppressWarnings("deprecation") // Superclass constructor deprecated
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    86
    protected ElementKindVisitor8() {
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    87
        super(null);
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    88
    }
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    89
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    90
    /**
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    91
     * Constructor for concrete subclasses; uses the argument for the
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    92
     * default value.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    93
     *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    94
     * @param defaultValue the value to assign to {@link #DEFAULT_VALUE}
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    95
     */
50964
225b61293064 8173606: Deprecate constructors of 7-era visitors
darcy
parents: 47216
diff changeset
    96
    @SuppressWarnings("deprecation") // Superclass constructor deprecated
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    97
    protected ElementKindVisitor8(R defaultValue) {
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    98
        super(defaultValue);
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    99
    }
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
   100
}