Tue, 05 Jul 2011 16:37:24 -0700
7025809: Provided new utility visitors supporting SourceVersion.RELEASE_8
Reviewed-by: jjg, mcimadamore
duke@1 | 1 | /* |
darcy@851 | 2 | * Copyright (c) 2005, 2011, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package javax.lang.model.util; |
duke@1 | 27 | |
duke@1 | 28 | import javax.lang.model.type.*; |
duke@1 | 29 | import javax.annotation.processing.SupportedSourceVersion; |
duke@1 | 30 | import javax.lang.model.SourceVersion; |
duke@1 | 31 | import static javax.lang.model.SourceVersion.*; |
duke@1 | 32 | |
duke@1 | 33 | |
duke@1 | 34 | /** |
duke@1 | 35 | * A simple visitor of types with default behavior appropriate for the |
duke@1 | 36 | * {@link SourceVersion#RELEASE_6 RELEASE_6} source version. |
duke@1 | 37 | * |
duke@1 | 38 | * Visit methods corresponding to {@code RELEASE_6} language |
darcy@851 | 39 | * constructs call {@link #defaultAction defaultAction}, passing their |
darcy@851 | 40 | * arguments to {@code defaultAction}'s corresponding parameters. |
darcy@851 | 41 | * |
darcy@851 | 42 | * For constructs introduced in {@code RELEASE_7} and later, {@code |
darcy@851 | 43 | * visitUnknown} is called instead. |
duke@1 | 44 | * |
duke@1 | 45 | * <p> Methods in this class may be overridden subject to their |
duke@1 | 46 | * general contract. Note that annotating methods in concrete |
duke@1 | 47 | * subclasses with {@link java.lang.Override @Override} will help |
duke@1 | 48 | * ensure that methods are overridden as intended. |
duke@1 | 49 | * |
duke@1 | 50 | * <p> <b>WARNING:</b> The {@code TypeVisitor} interface implemented |
duke@1 | 51 | * by this class may have methods added to it in the future to |
duke@1 | 52 | * accommodate new, currently unknown, language structures added to |
duke@1 | 53 | * future versions of the Java™ programming language. |
duke@1 | 54 | * Therefore, methods whose names begin with {@code "visit"} may be |
duke@1 | 55 | * added to this class in the future; to avoid incompatibilities, |
duke@1 | 56 | * classes which extend this class should not declare any instance |
duke@1 | 57 | * methods with names beginning with {@code "visit"}. |
duke@1 | 58 | * |
duke@1 | 59 | * <p>When such a new visit method is added, the default |
duke@1 | 60 | * implementation in this class will be to call the {@link |
duke@1 | 61 | * #visitUnknown visitUnknown} method. A new simple type visitor |
duke@1 | 62 | * class will also be introduced to correspond to the new language |
duke@1 | 63 | * level; this visitor will have different default behavior for the |
duke@1 | 64 | * visit method in question. When the new visitor is introduced, all |
duke@1 | 65 | * or portions of this visitor may be deprecated. |
duke@1 | 66 | * |
duke@1 | 67 | * @param <R> the return type of this visitor's methods. Use {@link |
duke@1 | 68 | * Void} for visitors that do not need to return results. |
duke@1 | 69 | * @param <P> the type of the additional parameter to this visitor's |
duke@1 | 70 | * methods. Use {@code Void} for visitors that do not need an |
duke@1 | 71 | * additional parameter. |
duke@1 | 72 | * |
duke@1 | 73 | * @author Joseph D. Darcy |
duke@1 | 74 | * @author Scott Seligman |
duke@1 | 75 | * @author Peter von der Ahé |
darcy@575 | 76 | * |
darcy@575 | 77 | * @see SimpleTypeVisitor7 |
darcy@1054 | 78 | * @see SimpleTypeVisitor8 |
duke@1 | 79 | * @since 1.6 |
duke@1 | 80 | */ |
duke@1 | 81 | @SupportedSourceVersion(RELEASE_6) |
duke@1 | 82 | public class SimpleTypeVisitor6<R, P> extends AbstractTypeVisitor6<R, P> { |
duke@1 | 83 | /** |
duke@1 | 84 | * Default value to be returned; {@link #defaultAction |
duke@1 | 85 | * defaultAction} returns this value unless the method is |
duke@1 | 86 | * overridden. |
duke@1 | 87 | */ |
duke@1 | 88 | protected final R DEFAULT_VALUE; |
duke@1 | 89 | |
duke@1 | 90 | /** |
duke@1 | 91 | * Constructor for concrete subclasses; uses {@code null} for the |
duke@1 | 92 | * default value. |
duke@1 | 93 | */ |
duke@1 | 94 | protected SimpleTypeVisitor6(){ |
duke@1 | 95 | DEFAULT_VALUE = null; |
duke@1 | 96 | } |
duke@1 | 97 | |
duke@1 | 98 | /** |
duke@1 | 99 | * Constructor for concrete subclasses; uses the argument for the |
duke@1 | 100 | * default value. |
duke@1 | 101 | * |
duke@1 | 102 | * @param defaultValue the value to assign to {@link #DEFAULT_VALUE} |
duke@1 | 103 | */ |
duke@1 | 104 | protected SimpleTypeVisitor6(R defaultValue){ |
duke@1 | 105 | DEFAULT_VALUE = defaultValue; |
duke@1 | 106 | } |
duke@1 | 107 | |
duke@1 | 108 | /** |
duke@1 | 109 | * The default action for visit methods. The implementation in |
duke@1 | 110 | * this class just returns {@link #DEFAULT_VALUE}; subclasses will |
duke@1 | 111 | * commonly override this method. |
duke@1 | 112 | */ |
duke@1 | 113 | protected R defaultAction(TypeMirror e, P p) { |
duke@1 | 114 | return DEFAULT_VALUE; |
duke@1 | 115 | } |
duke@1 | 116 | |
duke@1 | 117 | /** |
duke@1 | 118 | * {@inheritDoc} This implementation calls {@code defaultAction}. |
duke@1 | 119 | * |
duke@1 | 120 | * @param t {@inheritDoc} |
duke@1 | 121 | * @param p {@inheritDoc} |
duke@1 | 122 | * @return the result of {@code defaultAction} |
duke@1 | 123 | */ |
duke@1 | 124 | public R visitPrimitive(PrimitiveType t, P p) { |
duke@1 | 125 | return defaultAction(t, p); |
duke@1 | 126 | } |
duke@1 | 127 | |
duke@1 | 128 | /** |
duke@1 | 129 | * {@inheritDoc} This implementation calls {@code defaultAction}. |
duke@1 | 130 | * |
duke@1 | 131 | * @param t {@inheritDoc} |
duke@1 | 132 | * @param p {@inheritDoc} |
duke@1 | 133 | * @return the result of {@code defaultAction} |
duke@1 | 134 | */ |
duke@1 | 135 | public R visitNull(NullType t, P p){ |
duke@1 | 136 | return defaultAction(t, p); |
duke@1 | 137 | } |
duke@1 | 138 | |
duke@1 | 139 | /** |
duke@1 | 140 | * {@inheritDoc} This implementation calls {@code defaultAction}. |
duke@1 | 141 | * |
duke@1 | 142 | * @param t {@inheritDoc} |
duke@1 | 143 | * @param p {@inheritDoc} |
duke@1 | 144 | * @return the result of {@code defaultAction} |
duke@1 | 145 | */ |
duke@1 | 146 | public R visitArray(ArrayType t, P p){ |
duke@1 | 147 | return defaultAction(t, p); |
duke@1 | 148 | } |
duke@1 | 149 | |
duke@1 | 150 | /** |
duke@1 | 151 | * {@inheritDoc} This implementation calls {@code defaultAction}. |
duke@1 | 152 | * |
duke@1 | 153 | * @param t {@inheritDoc} |
duke@1 | 154 | * @param p {@inheritDoc} |
duke@1 | 155 | * @return the result of {@code defaultAction} |
duke@1 | 156 | */ |
duke@1 | 157 | public R visitDeclared(DeclaredType t, P p){ |
duke@1 | 158 | return defaultAction(t, p); |
duke@1 | 159 | } |
duke@1 | 160 | |
duke@1 | 161 | /** |
duke@1 | 162 | * {@inheritDoc} This implementation calls {@code defaultAction}. |
duke@1 | 163 | * |
duke@1 | 164 | * @param t {@inheritDoc} |
duke@1 | 165 | * @param p {@inheritDoc} |
duke@1 | 166 | * @return the result of {@code defaultAction} |
duke@1 | 167 | */ |
duke@1 | 168 | public R visitError(ErrorType t, P p){ |
duke@1 | 169 | return defaultAction(t, p); |
duke@1 | 170 | } |
duke@1 | 171 | |
duke@1 | 172 | /** |
duke@1 | 173 | * {@inheritDoc} This implementation calls {@code defaultAction}. |
duke@1 | 174 | * |
duke@1 | 175 | * @param t {@inheritDoc} |
duke@1 | 176 | * @param p {@inheritDoc} |
duke@1 | 177 | * @return the result of {@code defaultAction} |
duke@1 | 178 | */ |
duke@1 | 179 | public R visitTypeVariable(TypeVariable t, P p){ |
duke@1 | 180 | return defaultAction(t, p); |
duke@1 | 181 | } |
duke@1 | 182 | |
duke@1 | 183 | /** |
duke@1 | 184 | * {@inheritDoc} This implementation calls {@code defaultAction}. |
duke@1 | 185 | * |
duke@1 | 186 | * @param t {@inheritDoc} |
duke@1 | 187 | * @param p {@inheritDoc} |
duke@1 | 188 | * @return the result of {@code defaultAction} |
duke@1 | 189 | */ |
duke@1 | 190 | public R visitWildcard(WildcardType t, P p){ |
duke@1 | 191 | return defaultAction(t, p); |
duke@1 | 192 | } |
duke@1 | 193 | |
duke@1 | 194 | /** |
duke@1 | 195 | * {@inheritDoc} This implementation calls {@code defaultAction}. |
duke@1 | 196 | * |
duke@1 | 197 | * @param t {@inheritDoc} |
duke@1 | 198 | * @param p {@inheritDoc} |
duke@1 | 199 | * @return the result of {@code defaultAction} |
duke@1 | 200 | */ |
duke@1 | 201 | public R visitExecutable(ExecutableType t, P p) { |
duke@1 | 202 | return defaultAction(t, p); |
duke@1 | 203 | } |
duke@1 | 204 | |
duke@1 | 205 | /** |
duke@1 | 206 | * {@inheritDoc} This implementation calls {@code defaultAction}. |
duke@1 | 207 | * |
duke@1 | 208 | * @param t {@inheritDoc} |
duke@1 | 209 | * @param p {@inheritDoc} |
duke@1 | 210 | * @return the result of {@code defaultAction} |
duke@1 | 211 | */ |
duke@1 | 212 | public R visitNoType(NoType t, P p){ |
duke@1 | 213 | return defaultAction(t, p); |
duke@1 | 214 | } |
duke@1 | 215 | } |