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

Tue, 05 Jul 2011 16:37:24 -0700

author
darcy
date
Tue, 05 Jul 2011 16:37:24 -0700
changeset 1054
111bbf1ad913
child 1357
c75be5bc5283
permissions
-rw-r--r--

7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
Reviewed-by: jjg, mcimadamore

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

mercurial