/* * Copyright (c) 2010, 2011, Oracle and/or its affiliates. All rights reserved. * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. * * * * * * * * * * * * * * * * * * * * */ package javax.lang.model.util; import javax.lang.model.element.*; import static javax.lang.model.element.ElementKind.*; import javax.annotation.processing.SupportedSourceVersion; import static javax.lang.model.SourceVersion.*; import javax.lang.model.SourceVersion; /** * A visitor of program elements based on their {@linkplain * ElementKind kind} with default behavior appropriate for the {@link * SourceVersion#RELEASE_7 RELEASE_7} source version. For {@linkplain * Element elements} <tt><i>XYZ</i></tt> that may have more than one * kind, the <tt>visit<i>XYZ</i></tt> methods in this class delegate * to the <tt>visit<i>XYZKind</i></tt> method corresponding to the * first argument's kind. The <tt>visit<i>XYZKind</i></tt> 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 ElementVisitor} interface * implemented by this class may have methods added to it or the * {@code ElementKind} {@code enum} used in this case may have * constants 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 {@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 abstract element 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 ElementKindVisitor6 * @since 1.7 */ @SupportedSourceVersion(RELEASE_7) public class ElementKindVisitor7<R, P> extends ElementKindVisitor6<R, P> { /** * Constructor for concrete subclasses; uses {@code null} for the * default value. */ protected ElementKindVisitor7() { super(null); } /** * Constructor for concrete subclasses; uses the argument for the * default value. * * @param defaultValue the value to assign to {@link #DEFAULT_VALUE} */ protected ElementKindVisitor7(R defaultValue) { super(defaultValue); } /** * Visits a {@code RESOURCE_VARIABLE} variable element by calling * {@code defaultAction}. * * @param e {@inheritDoc} * @param p {@inheritDoc} * @return the result of {@code defaultAction} */ @Override public R visitVariableAsResourceVariable(VariableElement e, P p) { return defaultAction(e, p); } }