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

package javax.lang.model.util;

import javax.lang.model.type.*;
import javax.annotation.processing.SupportedSourceVersion;
import static javax.lang.model.SourceVersion.*;
import javax.lang.model.SourceVersion;

A visitor of types based on their kind with default behavior appropriate for the RELEASE_7 source version. For types Xyz that may have more than one kind, the visitXyz methods in this class delegate to the visitXyzAsKind method corresponding to the first argument's kind. The visitXyzAsKind methods call defaultAction, passing their arguments to defaultAction's corresponding parameters.

Methods in this class may be overridden subject to their general contract. Note that annotating methods in concrete subclasses with @Override will help ensure that methods are overridden as intended.

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

When such a new visit method is added, the default implementation in this class will be to call the visitUnknown method. A new type kind visitor class will also be introduced to correspond to the new language level; this visitor will have different default behavior for the visit method in question. When the new visitor is introduced, all or portions of this visitor may be deprecated.

Type parameters:
  • <R> – the return type of this visitor's methods. Use Void for visitors that do not need to return results.
  • <P> – the type of the additional parameter to this visitor's methods. Use Void for visitors that do not need an additional parameter.
See Also:
Since:1.7
/** * A visitor of types based on their {@linkplain TypeKind kind} with * default behavior appropriate for the {@link SourceVersion#RELEASE_7 * RELEASE_7} source version. For {@linkplain * TypeMirror types} <code><i>Xyz</i></code> that may have more than one * kind, the <code>visit<i>Xyz</i></code> methods in this class delegate * to the <code>visit<i>Xyz</i>As<i>Kind</i></code> method corresponding to the * first argument's kind. The <code>visit<i>Xyz</i>As<i>Kind</i></code> methods * call {@link #defaultAction defaultAction}, passing their arguments * to {@code defaultAction}'s corresponding parameters. * * <p> Methods in this class may be overridden subject to their * general contract. Note that annotating methods in concrete * subclasses with {@link java.lang.Override @Override} will help * ensure that methods are overridden as intended. * * <p> <b>WARNING:</b> The {@code TypeVisitor} interface implemented * by this class may have methods added to it in the future to * accommodate new, currently unknown, language structures added to * future versions of the Java&trade; programming language. * Therefore, methods whose names begin with {@code "visit"} may be * added to this class in the future; to avoid incompatibilities, * classes which extend this class should not declare any instance * methods with names beginning with {@code "visit"}. * * <p>When such a new visit method is added, the default * implementation in this class will be to call the {@link * #visitUnknown visitUnknown} method. A new type kind visitor class * will also be introduced to correspond to the new language level; * this visitor will have different default behavior for the visit * method in question. When the new visitor is introduced, all or * portions of this visitor may be deprecated. * * @param <R> the return type of this visitor's methods. Use {@link * Void} for visitors that do not need to return results. * @param <P> the type of the additional parameter to this visitor's * methods. Use {@code Void} for visitors that do not need an * additional parameter. * * @see TypeKindVisitor6 * @see TypeKindVisitor8 * @since 1.7 */
@SupportedSourceVersion(RELEASE_7) public class TypeKindVisitor7<R, P> extends TypeKindVisitor6<R, P> {
Constructor for concrete subclasses to call; uses null for the default value.
/** * Constructor for concrete subclasses to call; uses {@code null} * for the default value. */
@SuppressWarnings("deprecation") // Superclass constructor deprecated protected TypeKindVisitor7() { super(null); }
Constructor for concrete subclasses to call; uses the argument for the default value.
Params:
/** * Constructor for concrete subclasses to call; uses the argument * for the default value. * * @param defaultValue the value to assign to {@link #DEFAULT_VALUE} */
@SuppressWarnings("deprecation") // Superclass constructor deprecated protected TypeKindVisitor7(R defaultValue) { super(defaultValue); }
{@inheritDoc}
Params:
  • t – {@inheritDoc}
  • p – {@inheritDoc}
Implementation Requirements:This implementation calls defaultAction.
Returns:the result of defaultAction
/** * {@inheritDoc} * * @implSpec This implementation calls {@code defaultAction}. * * @param t {@inheritDoc} * @param p {@inheritDoc} * @return the result of {@code defaultAction} */
@Override public R visitUnion(UnionType t, P p) { return defaultAction(t, p); } }