src/share/classes/javax/lang/model/util/TypeKindVisitor7.java

Thu, 07 Nov 2013 20:11:56 -0800

author
darcy
date
Thu, 07 Nov 2013 20:11:56 -0800
changeset 2184
e39bd9401ea5
parent 1522
09f65aad4759
child 2525
2eb010b6cb22
permissions
-rw-r--r--

8027730: Fix release-8 type visitors to support intersection types
Reviewed-by: jjg, jlahoda, sogoel

darcy@575 1 /*
darcy@1522 2 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
darcy@575 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
darcy@575 4 *
darcy@575 5 * This code is free software; you can redistribute it and/or modify it
darcy@575 6 * under the terms of the GNU General Public License version 2 only, as
darcy@575 7 * published by the Free Software Foundation. Oracle designates this
darcy@575 8 * particular file as subject to the "Classpath" exception as provided
darcy@575 9 * by Oracle in the LICENSE file that accompanied this code.
darcy@575 10 *
darcy@575 11 * This code is distributed in the hope that it will be useful, but WITHOUT
darcy@575 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
darcy@575 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
darcy@575 14 * version 2 for more details (a copy is included in the LICENSE file that
darcy@575 15 * accompanied this code).
darcy@575 16 *
darcy@575 17 * You should have received a copy of the GNU General Public License version
darcy@575 18 * 2 along with this work; if not, write to the Free Software Foundation,
darcy@575 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
darcy@575 20 *
darcy@575 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
darcy@575 22 * or visit www.oracle.com if you need additional information or have any
darcy@575 23 * questions.
darcy@575 24 */
darcy@575 25
darcy@575 26 package javax.lang.model.util;
darcy@575 27
darcy@575 28 import javax.lang.model.type.*;
darcy@575 29 import javax.annotation.processing.SupportedSourceVersion;
darcy@575 30 import static javax.lang.model.SourceVersion.*;
darcy@575 31 import javax.lang.model.SourceVersion;
darcy@575 32
darcy@575 33 /**
darcy@575 34 * A visitor of types based on their {@linkplain TypeKind kind} with
darcy@575 35 * default behavior appropriate for the {@link SourceVersion#RELEASE_7
darcy@575 36 * RELEASE_7} source version. For {@linkplain
darcy@575 37 * TypeMirror types} <tt><i>XYZ</i></tt> that may have more than one
darcy@575 38 * kind, the <tt>visit<i>XYZ</i></tt> methods in this class delegate
darcy@575 39 * to the <tt>visit<i>XYZKind</i></tt> method corresponding to the
darcy@575 40 * first argument's kind. The <tt>visit<i>XYZKind</i></tt> methods
darcy@575 41 * call {@link #defaultAction defaultAction}, passing their arguments
darcy@575 42 * to {@code defaultAction}'s corresponding parameters.
darcy@575 43 *
darcy@575 44 * <p> Methods in this class may be overridden subject to their
darcy@575 45 * general contract. Note that annotating methods in concrete
darcy@575 46 * subclasses with {@link java.lang.Override @Override} will help
darcy@575 47 * ensure that methods are overridden as intended.
darcy@575 48 *
darcy@575 49 * <p> <b>WARNING:</b> The {@code TypeVisitor} interface implemented
darcy@575 50 * by this class may have methods added to it in the future to
darcy@575 51 * accommodate new, currently unknown, language structures added to
darcy@575 52 * future versions of the Java&trade; programming language.
darcy@575 53 * Therefore, methods whose names begin with {@code "visit"} may be
darcy@575 54 * added to this class in the future; to avoid incompatibilities,
darcy@575 55 * classes which extend this class should not declare any instance
darcy@575 56 * methods with names beginning with {@code "visit"}.
darcy@575 57 *
darcy@575 58 * <p>When such a new visit method is added, the default
darcy@575 59 * implementation in this class will be to call the {@link
darcy@575 60 * #visitUnknown visitUnknown} method. A new type kind visitor class
darcy@575 61 * will also be introduced to correspond to the new language level;
darcy@575 62 * this visitor will have different default behavior for the visit
darcy@575 63 * method in question. When the new visitor is introduced, all or
darcy@575 64 * portions of this visitor may be deprecated.
darcy@575 65 *
darcy@1522 66 * <p>Note that adding a default implementation of a new visit method
darcy@1522 67 * in a visitor class will occur instead of adding a <em>default
darcy@1522 68 * method</em> directly in the visitor interface since a Java SE 8
darcy@1522 69 * language feature cannot be used to this version of the API since
darcy@1522 70 * this version is required to be runnable on Java SE 7
darcy@1522 71 * implementations. Future versions of the API that are only required
darcy@1522 72 * to run on Java SE 8 and later may take advantage of default methods
darcy@1522 73 * in this situation.
darcy@1522 74 *
darcy@575 75 * @param <R> the return type of this visitor's methods. Use {@link
darcy@575 76 * Void} for visitors that do not need to return results.
darcy@575 77 * @param <P> the type of the additional parameter to this visitor's
darcy@575 78 * methods. Use {@code Void} for visitors that do not need an
darcy@575 79 * additional parameter.
darcy@575 80 *
darcy@575 81 * @see TypeKindVisitor6
darcy@1054 82 * @see TypeKindVisitor8
darcy@575 83 * @since 1.7
darcy@575 84 */
darcy@575 85 @SupportedSourceVersion(RELEASE_7)
darcy@575 86 public class TypeKindVisitor7<R, P> extends TypeKindVisitor6<R, P> {
darcy@575 87 /**
darcy@575 88 * Constructor for concrete subclasses to call; uses {@code null}
darcy@575 89 * for the default value.
darcy@575 90 */
darcy@575 91 protected TypeKindVisitor7() {
darcy@575 92 super(null);
darcy@575 93 }
darcy@575 94
darcy@575 95 /**
darcy@575 96 * Constructor for concrete subclasses to call; uses the argument
darcy@575 97 * for the default value.
darcy@575 98 *
darcy@575 99 * @param defaultValue the value to assign to {@link #DEFAULT_VALUE}
darcy@575 100 */
darcy@575 101 protected TypeKindVisitor7(R defaultValue) {
darcy@575 102 super(defaultValue);
darcy@575 103 }
darcy@851 104
darcy@851 105 /**
darcy@969 106 * This implementation visits a {@code UnionType} by calling
darcy@851 107 * {@code defaultAction}.
darcy@851 108 *
darcy@851 109 * @param t {@inheritDoc}
darcy@851 110 * @param p {@inheritDoc}
darcy@851 111 * @return the result of {@code defaultAction}
darcy@851 112 */
darcy@851 113 @Override
darcy@969 114 public R visitUnion(UnionType t, P p) {
darcy@851 115 return defaultAction(t, p);
darcy@851 116 }
darcy@575 117 }

mercurial