langtools/src/java.compiler/share/classes/javax/lang/model/util/TypeKindVisitor7.java
author darcy
Fri, 13 Jan 2017 19:29:55 -0800
changeset 43147 823bfbf9e914
parent 43133 08a858022ea6
child 43257 df68602dc422
permissions -rw-r--r--
8172531: Correct misstatements in javax.lang.model visitor documentation Reviewed-by: jjg
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5841
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
     1
/*
43147
823bfbf9e914 8172531: Correct misstatements in javax.lang.model visitor documentation
darcy
parents: 43133
diff changeset
     2
 * Copyright (c) 2010, 2017, Oracle and/or its affiliates. All rights reserved.
5841
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
     4
 *
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    10
 *
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    15
 * accompanied this code).
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    16
 *
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    20
 *
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    23
 * questions.
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    24
 */
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    25
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    26
package javax.lang.model.util;
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    27
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    28
import javax.lang.model.type.*;
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    29
import javax.annotation.processing.SupportedSourceVersion;
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    30
import static javax.lang.model.SourceVersion.*;
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    31
import javax.lang.model.SourceVersion;
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    32
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    33
/**
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    34
 * A visitor of types based on their {@linkplain TypeKind kind} with
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    35
 * default behavior appropriate for the {@link SourceVersion#RELEASE_7
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    36
 * RELEASE_7} source version.  For {@linkplain
43147
823bfbf9e914 8172531: Correct misstatements in javax.lang.model visitor documentation
darcy
parents: 43133
diff changeset
    37
 * TypeMirror types} <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
5841
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    41
 * call {@link #defaultAction defaultAction}, passing their arguments
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    42
 * to {@code defaultAction}'s corresponding parameters.
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    43
 *
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    44
 * <p> Methods in this class may be overridden subject to their
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    45
 * general contract.  Note that annotating methods in concrete
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    46
 * subclasses with {@link java.lang.Override @Override} will help
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    47
 * ensure that methods are overridden as intended.
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    48
 *
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    49
 * <p> <b>WARNING:</b> The {@code TypeVisitor} interface implemented
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    50
 * by this class may have methods added to it in the future to
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    51
 * accommodate new, currently unknown, language structures added to
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    52
 * future versions of the Java&trade; programming language.
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    53
 * Therefore, methods whose names begin with {@code "visit"} may be
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    54
 * added to this class in the future; to avoid incompatibilities,
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    55
 * classes which extend this class should not declare any instance
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    56
 * methods with names beginning with {@code "visit"}.
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    57
 *
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    58
 * <p>When such a new visit method is added, the default
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    59
 * implementation in this class will be to call the {@link
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    60
 * #visitUnknown visitUnknown} method.  A new type kind visitor class
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    61
 * will also be introduced to correspond to the new language level;
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    62
 * this visitor will have different default behavior for the visit
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    63
 * method in question.  When the new visitor is introduced, all or
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    64
 * portions of this visitor may be deprecated.
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    65
 *
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    66
 * @param <R> the return type of this visitor's methods.  Use {@link
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    67
 *            Void} for visitors that do not need to return results.
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    68
 * @param <P> the type of the additional parameter to this visitor's
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    69
 *            methods.  Use {@code Void} for visitors that do not need an
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    70
 *            additional parameter.
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    71
 *
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    72
 * @see TypeKindVisitor6
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents: 9300
diff changeset
    73
 * @see TypeKindVisitor8
5841
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    74
 * @since 1.7
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    75
 */
25696
86204c8c6771 8051482: Fix deprecation warnings in javax.lang.model.util
darcy
parents: 15386
diff changeset
    76
@SuppressWarnings("deprecation") // Superclass deprecated
5841
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    77
@SupportedSourceVersion(RELEASE_7)
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    78
public class TypeKindVisitor7<R, P> extends TypeKindVisitor6<R, P> {
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    79
    /**
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    80
     * Constructor for concrete subclasses to call; uses {@code null}
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    81
     * for the default value.
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    82
     */
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    83
    protected TypeKindVisitor7() {
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    84
        super(null);
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    85
    }
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    86
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    87
    /**
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    88
     * Constructor for concrete subclasses to call; uses the argument
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    89
     * for the default value.
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    90
     *
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    91
     * @param defaultValue the value to assign to {@link #DEFAULT_VALUE}
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    92
     */
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    93
    protected TypeKindVisitor7(R defaultValue) {
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    94
        super(defaultValue);
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
    95
    }
8235
0f7e1f7a6a4b 6961571: Update visitors to support ARM's ElementKind.RESOURCE_VARIABLE
darcy
parents: 5841
diff changeset
    96
0f7e1f7a6a4b 6961571: Update visitors to support ARM's ElementKind.RESOURCE_VARIABLE
darcy
parents: 5841
diff changeset
    97
    /**
9300
c2de4dd9853b 7033809: Rename "disjunctive" to "union" in javax.lang.model
darcy
parents: 8235
diff changeset
    98
     * This implementation visits a {@code UnionType} by calling
8235
0f7e1f7a6a4b 6961571: Update visitors to support ARM's ElementKind.RESOURCE_VARIABLE
darcy
parents: 5841
diff changeset
    99
     * {@code defaultAction}.
0f7e1f7a6a4b 6961571: Update visitors to support ARM's ElementKind.RESOURCE_VARIABLE
darcy
parents: 5841
diff changeset
   100
     *
0f7e1f7a6a4b 6961571: Update visitors to support ARM's ElementKind.RESOURCE_VARIABLE
darcy
parents: 5841
diff changeset
   101
     * @param t  {@inheritDoc}
0f7e1f7a6a4b 6961571: Update visitors to support ARM's ElementKind.RESOURCE_VARIABLE
darcy
parents: 5841
diff changeset
   102
     * @param p  {@inheritDoc}
0f7e1f7a6a4b 6961571: Update visitors to support ARM's ElementKind.RESOURCE_VARIABLE
darcy
parents: 5841
diff changeset
   103
     * @return the result of {@code defaultAction}
0f7e1f7a6a4b 6961571: Update visitors to support ARM's ElementKind.RESOURCE_VARIABLE
darcy
parents: 5841
diff changeset
   104
     */
0f7e1f7a6a4b 6961571: Update visitors to support ARM's ElementKind.RESOURCE_VARIABLE
darcy
parents: 5841
diff changeset
   105
    @Override
9300
c2de4dd9853b 7033809: Rename "disjunctive" to "union" in javax.lang.model
darcy
parents: 8235
diff changeset
   106
    public R visitUnion(UnionType t, P p) {
8235
0f7e1f7a6a4b 6961571: Update visitors to support ARM's ElementKind.RESOURCE_VARIABLE
darcy
parents: 5841
diff changeset
   107
        return defaultAction(t, p);
0f7e1f7a6a4b 6961571: Update visitors to support ARM's ElementKind.RESOURCE_VARIABLE
darcy
parents: 5841
diff changeset
   108
    }
5841
7a8448425bb7 6933147: Provided new utility visitors supporting SourceVersion.RELEASE_7
darcy
parents:
diff changeset
   109
}