Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/javax/lang/model/util/AbstractTypeVisitor7.java@09f65aad4759 (annotated)
src/share/classes/javax/lang/model/util/AbstractTypeVisitor7.java
Wed, 23 Jan 2013 20:11:07 -0800
- author
- darcy
- date
- Wed, 23 Jan 2013 20:11:07 -0800
- changeset 1522
- 09f65aad4759
- parent 1054
- 111bbf1ad913
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
8006264: Add explanation of why default methods cannot be used in JDK 8 javax.lang.model
Reviewed-by: jjg
| darcy@575 | 1 | /* |
| darcy@1522 | 2 | * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved. |
| darcy@575 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| darcy@575 | 4 | * |
| darcy@575 | 5 | * This code is free software; you can redistribute it and/or modify it |
| darcy@575 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| darcy@575 | 7 | * published by the Free Software Foundation. Oracle designates this |
| darcy@575 | 8 | * particular file as subject to the "Classpath" exception as provided |
| darcy@575 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| darcy@575 | 10 | * |
| darcy@575 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| darcy@575 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| darcy@575 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| darcy@575 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| darcy@575 | 15 | * accompanied this code). |
| darcy@575 | 16 | * |
| darcy@575 | 17 | * You should have received a copy of the GNU General Public License version |
| darcy@575 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| darcy@575 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| darcy@575 | 20 | * |
| darcy@575 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| darcy@575 | 22 | * or visit www.oracle.com if you need additional information or have any |
| darcy@575 | 23 | * questions. |
| darcy@575 | 24 | */ |
| darcy@575 | 25 | |
| darcy@575 | 26 | package javax.lang.model.util; |
| darcy@575 | 27 | |
| darcy@575 | 28 | import javax.lang.model.type.*; |
| darcy@575 | 29 | |
| darcy@575 | 30 | /** |
| darcy@575 | 31 | * A skeletal visitor of types with default behavior appropriate for |
| darcy@851 | 32 | * the {@link javax.lang.model.SourceVersion#RELEASE_7 RELEASE_7} |
| darcy@851 | 33 | * source version. |
| darcy@575 | 34 | * |
| darcy@575 | 35 | * <p> <b>WARNING:</b> The {@code TypeVisitor} interface implemented |
| darcy@575 | 36 | * by this class may have methods added to it in the future to |
| darcy@575 | 37 | * accommodate new, currently unknown, language structures added to |
| darcy@575 | 38 | * future versions of the Java™ programming language. |
| darcy@575 | 39 | * Therefore, methods whose names begin with {@code "visit"} may be |
| darcy@575 | 40 | * added to this class in the future; to avoid incompatibilities, |
| darcy@575 | 41 | * classes which extend this class should not declare any instance |
| darcy@575 | 42 | * methods with names beginning with {@code "visit"}. |
| darcy@575 | 43 | * |
| darcy@575 | 44 | * <p>When such a new visit method is added, the default |
| darcy@575 | 45 | * implementation in this class will be to call the {@link |
| darcy@575 | 46 | * #visitUnknown visitUnknown} method. A new abstract type visitor |
| darcy@575 | 47 | * class will also be introduced to correspond to the new language |
| darcy@575 | 48 | * level; this visitor will have different default behavior for the |
| darcy@575 | 49 | * visit method in question. When the new visitor is introduced, all |
| darcy@575 | 50 | * or portions of this visitor may be deprecated. |
| darcy@575 | 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 | * |
| darcy@575 | 61 | * @param <R> the return type of this visitor's methods. Use {@link |
| darcy@575 | 62 | * Void} for visitors that do not need to return results. |
| darcy@575 | 63 | * @param <P> the type of the additional parameter to this visitor's |
| darcy@575 | 64 | * methods. Use {@code Void} for visitors that do not need an |
| darcy@575 | 65 | * additional parameter. |
| darcy@575 | 66 | * |
| darcy@575 | 67 | * @see AbstractTypeVisitor6 |
| darcy@1054 | 68 | * @see AbstractTypeVisitor8 |
| darcy@575 | 69 | * @since 1.7 |
| darcy@575 | 70 | */ |
| darcy@575 | 71 | public abstract class AbstractTypeVisitor7<R, P> extends AbstractTypeVisitor6<R, P> { |
| darcy@575 | 72 | /** |
| darcy@575 | 73 | * Constructor for concrete subclasses to call. |
| darcy@575 | 74 | */ |
| darcy@575 | 75 | protected AbstractTypeVisitor7() { |
| darcy@575 | 76 | super(); |
| darcy@575 | 77 | } |
| darcy@851 | 78 | |
| darcy@851 | 79 | /** |
| darcy@969 | 80 | * Visits a {@code UnionType} in a manner defined by a subclass. |
| darcy@851 | 81 | * |
| darcy@851 | 82 | * @param t {@inheritDoc} |
| darcy@851 | 83 | * @param p {@inheritDoc} |
| darcy@851 | 84 | * @return the result of the visit as defined by a subclass |
| darcy@851 | 85 | */ |
| darcy@969 | 86 | public abstract R visitUnion(UnionType t, P p); |
| darcy@575 | 87 | } |
