duke@1: /* darcy@851: * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. duke@1: * duke@1: * This code is free software; you can redistribute it and/or modify it duke@1: * under the terms of the GNU General Public License version 2 only, as ohair@554: * published by the Free Software Foundation. Oracle designates this duke@1: * particular file as subject to the "Classpath" exception as provided ohair@554: * by Oracle in the LICENSE file that accompanied this code. duke@1: * duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License duke@1: * version 2 for more details (a copy is included in the LICENSE file that duke@1: * accompanied this code). duke@1: * duke@1: * You should have received a copy of the GNU General Public License version duke@1: * 2 along with this work; if not, write to the Free Software Foundation, duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. duke@1: * ohair@554: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA ohair@554: * or visit www.oracle.com if you need additional information or have any ohair@554: * questions. duke@1: */ duke@1: duke@1: package javax.lang.model.util; duke@1: duke@1: import javax.lang.model.type.*; duke@1: duke@1: /** duke@1: * A skeletal visitor of types with default behavior appropriate for darcy@851: * the {@link javax.lang.model.SourceVersion#RELEASE_6 RELEASE_6} darcy@851: * source version. duke@1: * duke@1: *

WARNING: The {@code TypeVisitor} interface implemented duke@1: * by this class may have methods added to it in the future to duke@1: * accommodate new, currently unknown, language structures added to duke@1: * future versions of the Java™ programming language. duke@1: * Therefore, methods whose names begin with {@code "visit"} may be duke@1: * added to this class in the future; to avoid incompatibilities, duke@1: * classes which extend this class should not declare any instance duke@1: * methods with names beginning with {@code "visit"}. duke@1: * duke@1: *

When such a new visit method is added, the default duke@1: * implementation in this class will be to call the {@link duke@1: * #visitUnknown visitUnknown} method. A new abstract type visitor duke@1: * class will also be introduced to correspond to the new language duke@1: * level; this visitor will have different default behavior for the duke@1: * visit method in question. When the new visitor is introduced, all duke@1: * or portions of this visitor may be deprecated. duke@1: * duke@1: * @param the return type of this visitor's methods. Use {@link duke@1: * Void} for visitors that do not need to return results. duke@1: * @param

the type of the additional parameter to this visitor's duke@1: * methods. Use {@code Void} for visitors that do not need an duke@1: * additional parameter. duke@1: * duke@1: * @author Joseph D. Darcy duke@1: * @author Scott Seligman duke@1: * @author Peter von der Ahé darcy@575: * darcy@575: * @see AbstractTypeVisitor7 duke@1: * @since 1.6 duke@1: */ duke@1: public abstract class AbstractTypeVisitor6 implements TypeVisitor { duke@1: /** duke@1: * Constructor for concrete subclasses to call. duke@1: */ duke@1: protected AbstractTypeVisitor6() {} duke@1: duke@1: /** duke@1: * Visits any type mirror as if by passing itself to that type duke@1: * mirror's {@link TypeMirror#accept accept} method. The duke@1: * invocation {@code v.visit(t, p)} is equivalent to {@code duke@1: * t.accept(v, p)}. duke@1: * duke@1: * @param t the type to visit duke@1: * @param p a visitor-specified parameter duke@1: * @return a visitor-specified result duke@1: */ duke@1: public final R visit(TypeMirror t, P p) { duke@1: return t.accept(this, p); duke@1: } duke@1: duke@1: /** duke@1: * Visits any type mirror as if by passing itself to that type duke@1: * mirror's {@link TypeMirror#accept accept} method and passing duke@1: * {@code null} for the additional parameter. The invocation duke@1: * {@code v.visit(t)} is equivalent to {@code t.accept(v, null)}. duke@1: * duke@1: * @param t the type to visit duke@1: * @return a visitor-specified result duke@1: */ duke@1: public final R visit(TypeMirror t) { duke@1: return t.accept(this, null); duke@1: } duke@1: duke@1: /** darcy@969: * Visits a {@code UnionType} element by calling {@code darcy@851: * visitUnknown}. darcy@851: darcy@851: * @param t {@inheritDoc} darcy@851: * @param p {@inheritDoc} darcy@851: * @return the result of {@code visitUnknown} darcy@851: * darcy@851: * @since 1.7 darcy@851: */ darcy@969: public R visitUnion(UnionType t, P p) { darcy@851: return visitUnknown(t, p); darcy@851: } darcy@851: darcy@851: /** duke@1: * {@inheritDoc} duke@1: * duke@1: *

The default implementation of this method in {@code duke@1: * AbstractTypeVisitor6} will always throw {@code duke@1: * UnknownTypeException}. This behavior is not required of a duke@1: * subclass. duke@1: * duke@1: * @param t the type to visit duke@1: * @return a visitor-specified result duke@1: * @throws UnknownTypeException duke@1: * a visitor implementation may optionally throw this exception duke@1: */ duke@1: public R visitUnknown(TypeMirror t, P p) { duke@1: throw new UnknownTypeException(t, p); duke@1: } duke@1: }