langtools/src/share/classes/javax/lang/model/util/TypeKindVisitor8.java
author darcy
Tue, 05 Jul 2011 16:37:24 -0700
changeset 10192 378321489bea
child 14258 8d2148961366
permissions -rw-r--r--
7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8 Reviewed-by: jjg, mcimadamore
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
/*
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
     2
 * Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved.
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.type.*;
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.element.ElementKind.*;
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    31
import static javax.lang.model.SourceVersion.*;
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    32
import javax.lang.model.SourceVersion;
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
/**
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    35
 * A visitor of types based on their {@linkplain TypeKind kind} with
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    36
 * default behavior appropriate for the {@link SourceVersion#RELEASE_8
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    37
 * RELEASE_8} source version.  For {@linkplain
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    38
 * TypeMirror types} <tt><i>XYZ</i></tt> that may have more than one
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    39
 * kind, the <tt>visit<i>XYZ</i></tt> methods in this class delegate
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    40
 * to the <tt>visit<i>XYZKind</i></tt> method corresponding to the
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    41
 * first argument's kind.  The <tt>visit<i>XYZKind</i></tt> methods
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    42
 * call {@link #defaultAction defaultAction}, passing their arguments
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    43
 * to {@code defaultAction}'s corresponding parameters.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    44
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    45
 * <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
    46
 * general contract.  Note that annotating methods in concrete
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    47
 * subclasses with {@link java.lang.Override @Override} will help
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    48
 * ensure that methods are overridden as intended.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    49
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    50
 * <p> <b>WARNING:</b> The {@code TypeVisitor} interface implemented
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    51
 * by this class may have methods added to it in the future to
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    52
 * accommodate new, currently unknown, language structures added to
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    53
 * future versions of the Java&trade; programming language.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    54
 * Therefore, methods whose names begin with {@code "visit"} may be
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    55
 * added to this class in the future; to avoid incompatibilities,
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    56
 * classes which extend this class should not declare any instance
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    57
 * methods with names beginning with {@code "visit"}.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    58
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    59
 * <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
    60
 * implementation in this class will be to call the {@link
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    61
 * #visitUnknown visitUnknown} method.  A new type kind visitor class
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    62
 * will also be introduced to correspond to the new language level;
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    63
 * this visitor will have different default behavior for the visit
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    64
 * method in question.  When the new visitor is introduced, all or
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    65
 * portions of this visitor may be deprecated.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    66
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    67
 * @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
    68
 *            Void} for visitors that do not need to return results.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    69
 * @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
    70
 *            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
    71
 *            additional parameter.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    72
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    73
 * @see TypeKindVisitor6
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    74
 * @see TypeKindVisitor7
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    75
 * @since 1.8
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    76
 */
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    77
@SupportedSourceVersion(RELEASE_8)
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    78
public class TypeKindVisitor8<R, P> extends TypeKindVisitor7<R, P> {
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    79
    /**
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    80
     * Constructor for concrete subclasses to call; uses {@code null}
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    81
     * for the default value.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    82
     */
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    83
    protected TypeKindVisitor8() {
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    84
        super(null);
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    85
    }
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    86
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    87
    /**
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    88
     * Constructor for concrete subclasses to call; uses the argument
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    89
     * for the default value.
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
     * @param defaultValue the value to assign to {@link #DEFAULT_VALUE}
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    92
     */
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    93
    protected TypeKindVisitor8(R defaultValue) {
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    94
        super(defaultValue);
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    95
    }
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    96
}