langtools/src/java.compiler/share/classes/javax/lang/model/util/AbstractTypeVisitor8.java
author darcy
Wed, 29 Jun 2016 19:24:40 -0700
changeset 39367 3a9d6e8c6fde
parent 25874 83c19f00452c
child 43147 823bfbf9e914
permissions -rw-r--r--
8160506: Use @implSpec tags in javax.lang.model.util Reviewed-by: jjg
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
/*
25690
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 15386
diff changeset
     2
 * Copyright (c) 2011, 2014, 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
25690
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 15386
diff changeset
    28
import javax.annotation.processing.SupportedSourceVersion;
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    29
import javax.lang.model.type.*;
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    30
25690
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 15386
diff changeset
    31
import static javax.lang.model.SourceVersion.*;
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 15386
diff changeset
    32
10192
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 skeletal visitor of types with default behavior appropriate for
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    35
 * the {@link javax.lang.model.SourceVersion#RELEASE_8 RELEASE_8}
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    36
 * source version.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    37
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    38
 * <p> <b>WARNING:</b> The {@code TypeVisitor} interface implemented
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    39
 * 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
    40
 * accommodate new, currently unknown, language structures added to
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    41
 * future versions of the Java&trade; programming language.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    42
 * Therefore, methods whose names begin with {@code "visit"} may be
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    43
 * added to this class in the future; to avoid incompatibilities,
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    44
 * classes which extend this class should not declare any instance
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    45
 * methods with names beginning with {@code "visit"}.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    46
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    47
 * <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
    48
 * implementation in this class will be to call the {@link
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    49
 * #visitUnknown visitUnknown} method.  A new abstract type visitor
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    50
 * class will also be introduced to correspond to the new language
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    51
 * level; this visitor will have different default behavior for the
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    52
 * visit method in question.  When the new visitor is introduced, all
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    53
 * or portions of this visitor may be deprecated.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    54
 *
15386
92bc08d96f0c 8006264: Add explanation of why default methods cannot be used in JDK 8 javax.lang.model
darcy
parents: 14870
diff changeset
    55
 * <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: 14870
diff changeset
    56
 * 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: 14870
diff changeset
    57
 * 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: 14870
diff changeset
    58
 * 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: 14870
diff changeset
    59
 * 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: 14870
diff changeset
    60
 * 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: 14870
diff changeset
    61
 * 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: 14870
diff changeset
    62
 * in this situation.
92bc08d96f0c 8006264: Add explanation of why default methods cannot be used in JDK 8 javax.lang.model
darcy
parents: 14870
diff changeset
    63
 *
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    64
 * @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
    65
 *            Void} for visitors that do not need to return results.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    66
 * @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
    67
 *            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
    68
 *            additional parameter.
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    69
 *
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    70
 * @see AbstractTypeVisitor6
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    71
 * @see AbstractTypeVisitor7
25690
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 15386
diff changeset
    72
 * @see AbstractTypeVisitor9
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    73
 * @since 1.8
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    74
 */
25690
b1dac768ab79 8050430: Provided new utility visitors supporting SourceVersion.RELEASE_9
darcy
parents: 15386
diff changeset
    75
@SupportedSourceVersion(RELEASE_8)
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    76
public abstract class AbstractTypeVisitor8<R, P> extends AbstractTypeVisitor7<R, P> {
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    77
    /**
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    78
     * Constructor for concrete subclasses to call.
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
    protected AbstractTypeVisitor8() {
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    81
        super();
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    82
    }
14725
65836e833f59 8002099: Add support for intersection types in cast expression
mcimadamore
parents: 10192
diff changeset
    83
65836e833f59 8002099: Add support for intersection types in cast expression
mcimadamore
parents: 10192
diff changeset
    84
    /**
65836e833f59 8002099: Add support for intersection types in cast expression
mcimadamore
parents: 10192
diff changeset
    85
     * Visits an {@code IntersectionType} in a manner defined by a subclass.
65836e833f59 8002099: Add support for intersection types in cast expression
mcimadamore
parents: 10192
diff changeset
    86
     *
65836e833f59 8002099: Add support for intersection types in cast expression
mcimadamore
parents: 10192
diff changeset
    87
     * @param t  {@inheritDoc}
65836e833f59 8002099: Add support for intersection types in cast expression
mcimadamore
parents: 10192
diff changeset
    88
     * @param p  {@inheritDoc}
65836e833f59 8002099: Add support for intersection types in cast expression
mcimadamore
parents: 10192
diff changeset
    89
     * @return the result of the visit as defined by a subclass
65836e833f59 8002099: Add support for intersection types in cast expression
mcimadamore
parents: 10192
diff changeset
    90
     */
39367
3a9d6e8c6fde 8160506: Use @implSpec tags in javax.lang.model.util
darcy
parents: 25874
diff changeset
    91
    @Override
14725
65836e833f59 8002099: Add support for intersection types in cast expression
mcimadamore
parents: 10192
diff changeset
    92
    public abstract R visitIntersection(IntersectionType t, P p);
10192
378321489bea 7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
darcy
parents:
diff changeset
    93
}