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

Tue, 17 Dec 2013 10:26:10 -0800

author
darcy
date
Tue, 17 Dec 2013 10:26:10 -0800
changeset 2223
6d1f9d1fd585
parent 1644
40adaf938847
child 2525
2eb010b6cb22
permissions
-rw-r--r--

8030080: Correct misstatement in JSR 269 MR (in javax.lang.model)
Reviewed-by: jfranck

duke@1 1 /*
jjg@1521 2 * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
duke@1 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1 4 *
duke@1 5 * This code is free software; you can redistribute it and/or modify it
duke@1 6 * under the terms of the GNU General Public License version 2 only, as
ohair@554 7 * published by the Free Software Foundation. Oracle designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
ohair@554 9 * by Oracle in the LICENSE file that accompanied this code.
duke@1 10 *
duke@1 11 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1 14 * version 2 for more details (a copy is included in the LICENSE file that
duke@1 15 * accompanied this code).
duke@1 16 *
duke@1 17 * You should have received a copy of the GNU General Public License version
duke@1 18 * 2 along with this work; if not, write to the Free Software Foundation,
duke@1 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1 20 *
ohair@554 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554 22 * or visit www.oracle.com if you need additional information or have any
ohair@554 23 * questions.
duke@1 24 */
duke@1 25
duke@1 26 package javax.lang.model.util;
duke@1 27
duke@1 28 import javax.lang.model.type.*;
duke@1 29
duke@1 30 /**
duke@1 31 * A skeletal visitor of types with default behavior appropriate for
darcy@851 32 * the {@link javax.lang.model.SourceVersion#RELEASE_6 RELEASE_6}
darcy@851 33 * source version.
duke@1 34 *
duke@1 35 * <p> <b>WARNING:</b> The {@code TypeVisitor} interface implemented
duke@1 36 * by this class may have methods added to it in the future to
duke@1 37 * accommodate new, currently unknown, language structures added to
duke@1 38 * future versions of the Java&trade; programming language.
duke@1 39 * Therefore, methods whose names begin with {@code "visit"} may be
duke@1 40 * added to this class in the future; to avoid incompatibilities,
duke@1 41 * classes which extend this class should not declare any instance
duke@1 42 * methods with names beginning with {@code "visit"}.
duke@1 43 *
duke@1 44 * <p>When such a new visit method is added, the default
duke@1 45 * implementation in this class will be to call the {@link
duke@1 46 * #visitUnknown visitUnknown} method. A new abstract type visitor
duke@1 47 * class will also be introduced to correspond to the new language
duke@1 48 * level; this visitor will have different default behavior for the
duke@1 49 * visit method in question. When the new visitor is introduced, all
duke@1 50 * or portions of this visitor may be deprecated.
duke@1 51 *
darcy@1522 52 * <p>Note that adding a default implementation of a new visit method
darcy@1522 53 * in a visitor class will occur instead of adding a <em>default
darcy@1522 54 * method</em> directly in the visitor interface since a Java SE 8
darcy@1522 55 * language feature cannot be used to this version of the API since
darcy@1522 56 * this version is required to be runnable on Java SE 7
darcy@1522 57 * implementations. Future versions of the API that are only required
darcy@1522 58 * to run on Java SE 8 and later may take advantage of default methods
darcy@1522 59 * in this situation.
darcy@1522 60 *
duke@1 61 * @param <R> the return type of this visitor's methods. Use {@link
duke@1 62 * Void} for visitors that do not need to return results.
duke@1 63 * @param <P> the type of the additional parameter to this visitor's
duke@1 64 * methods. Use {@code Void} for visitors that do not need an
duke@1 65 * additional parameter.
duke@1 66 *
duke@1 67 * @author Joseph D. Darcy
duke@1 68 * @author Scott Seligman
duke@1 69 * @author Peter von der Ah&eacute;
darcy@575 70 *
darcy@575 71 * @see AbstractTypeVisitor7
darcy@1054 72 * @see AbstractTypeVisitor8
duke@1 73 * @since 1.6
duke@1 74 */
duke@1 75 public abstract class AbstractTypeVisitor6<R, P> implements TypeVisitor<R, P> {
duke@1 76 /**
duke@1 77 * Constructor for concrete subclasses to call.
duke@1 78 */
duke@1 79 protected AbstractTypeVisitor6() {}
duke@1 80
duke@1 81 /**
duke@1 82 * Visits any type mirror as if by passing itself to that type
duke@1 83 * mirror's {@link TypeMirror#accept accept} method. The
duke@1 84 * invocation {@code v.visit(t, p)} is equivalent to {@code
duke@1 85 * t.accept(v, p)}.
duke@1 86 *
duke@1 87 * @param t the type to visit
duke@1 88 * @param p a visitor-specified parameter
duke@1 89 * @return a visitor-specified result
duke@1 90 */
duke@1 91 public final R visit(TypeMirror t, P p) {
duke@1 92 return t.accept(this, p);
duke@1 93 }
duke@1 94
duke@1 95 /**
duke@1 96 * Visits any type mirror as if by passing itself to that type
duke@1 97 * mirror's {@link TypeMirror#accept accept} method and passing
duke@1 98 * {@code null} for the additional parameter. The invocation
duke@1 99 * {@code v.visit(t)} is equivalent to {@code t.accept(v, null)}.
duke@1 100 *
duke@1 101 * @param t the type to visit
duke@1 102 * @return a visitor-specified result
duke@1 103 */
duke@1 104 public final R visit(TypeMirror t) {
duke@1 105 return t.accept(this, null);
duke@1 106 }
duke@1 107
duke@1 108 /**
darcy@969 109 * Visits a {@code UnionType} element by calling {@code
darcy@851 110 * visitUnknown}.
darcy@851 111
darcy@851 112 * @param t {@inheritDoc}
darcy@851 113 * @param p {@inheritDoc}
darcy@851 114 * @return the result of {@code visitUnknown}
darcy@851 115 *
darcy@851 116 * @since 1.7
darcy@851 117 */
darcy@969 118 public R visitUnion(UnionType t, P p) {
darcy@851 119 return visitUnknown(t, p);
darcy@851 120 }
darcy@851 121
darcy@851 122 /**
mcimadamore@1436 123 * Visits an {@code IntersectionType} element by calling {@code
mcimadamore@1436 124 * visitUnknown}.
mcimadamore@1436 125
mcimadamore@1436 126 * @param t {@inheritDoc}
mcimadamore@1436 127 * @param p {@inheritDoc}
mcimadamore@1436 128 * @return the result of {@code visitUnknown}
mcimadamore@1436 129 *
mcimadamore@1436 130 * @since 1.8
mcimadamore@1436 131 */
mcimadamore@1436 132 public R visitIntersection(IntersectionType t, P p) {
mcimadamore@1436 133 return visitUnknown(t, p);
mcimadamore@1436 134 }
mcimadamore@1436 135
mcimadamore@1436 136 /**
duke@1 137 * {@inheritDoc}
duke@1 138 *
duke@1 139 * <p> The default implementation of this method in {@code
duke@1 140 * AbstractTypeVisitor6} will always throw {@code
duke@1 141 * UnknownTypeException}. This behavior is not required of a
duke@1 142 * subclass.
duke@1 143 *
duke@1 144 * @param t the type to visit
duke@1 145 * @return a visitor-specified result
duke@1 146 * @throws UnknownTypeException
duke@1 147 * a visitor implementation may optionally throw this exception
duke@1 148 */
duke@1 149 public R visitUnknown(TypeMirror t, P p) {
duke@1 150 throw new UnknownTypeException(t, p);
duke@1 151 }
duke@1 152 }

mercurial