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

Tue, 28 Dec 2010 15:54:52 -0800

author
ohair
date
Tue, 28 Dec 2010 15:54:52 -0800
changeset 798
4868a36f6fd8
parent 575
9a7c998bf2fc
child 1054
111bbf1ad913
permissions
-rw-r--r--

6962318: Update copyright year
Reviewed-by: xdono

duke@1 1 /*
ohair@798 2 * Copyright (c) 2005, 2010, 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
duke@1 29 import javax.lang.model.type.*;
duke@1 30 import javax.annotation.processing.SupportedSourceVersion;
duke@1 31 import static javax.lang.model.element.ElementKind.*;
duke@1 32 import static javax.lang.model.SourceVersion.*;
duke@1 33 import javax.lang.model.SourceVersion;
duke@1 34
duke@1 35 /**
duke@1 36 * A visitor of types based on their {@linkplain TypeKind kind} with
duke@1 37 * default behavior appropriate for the {@link SourceVersion#RELEASE_6
duke@1 38 * RELEASE_6} source version. For {@linkplain
duke@1 39 * TypeMirror types} <tt><i>XYZ</i></tt> that may have more than one
duke@1 40 * kind, the <tt>visit<i>XYZ</i></tt> methods in this class delegate
duke@1 41 * to the <tt>visit<i>XYZKind</i></tt> method corresponding to the
duke@1 42 * first argument's kind. The <tt>visit<i>XYZKind</i></tt> methods
duke@1 43 * call {@link #defaultAction defaultAction}, passing their arguments
duke@1 44 * to {@code defaultAction}'s corresponding parameters.
duke@1 45 *
duke@1 46 * <p> Methods in this class may be overridden subject to their
duke@1 47 * general contract. Note that annotating methods in concrete
duke@1 48 * subclasses with {@link java.lang.Override @Override} will help
duke@1 49 * ensure that methods are overridden as intended.
duke@1 50 *
duke@1 51 * <p> <b>WARNING:</b> The {@code TypeVisitor} interface implemented
duke@1 52 * by this class may have methods added to it in the future to
duke@1 53 * accommodate new, currently unknown, language structures added to
duke@1 54 * future versions of the Java&trade; programming language.
duke@1 55 * Therefore, methods whose names begin with {@code "visit"} may be
duke@1 56 * added to this class in the future; to avoid incompatibilities,
duke@1 57 * classes which extend this class should not declare any instance
duke@1 58 * methods with names beginning with {@code "visit"}.
duke@1 59 *
duke@1 60 * <p>When such a new visit method is added, the default
duke@1 61 * implementation in this class will be to call the {@link
duke@1 62 * #visitUnknown visitUnknown} method. A new type kind visitor class
duke@1 63 * will also be introduced to correspond to the new language level;
duke@1 64 * this visitor will have different default behavior for the visit
duke@1 65 * method in question. When the new visitor is introduced, all or
duke@1 66 * portions of this visitor may be deprecated.
duke@1 67 *
duke@1 68 * @param <R> the return type of this visitor's methods. Use {@link
duke@1 69 * Void} for visitors that do not need to return results.
duke@1 70 * @param <P> the type of the additional parameter to this visitor's
duke@1 71 * methods. Use {@code Void} for visitors that do not need an
duke@1 72 * additional parameter.
duke@1 73 *
duke@1 74 * @author Joseph D. Darcy
duke@1 75 * @author Scott Seligman
duke@1 76 * @author Peter von der Ah&eacute;
darcy@575 77 *
darcy@575 78 * @see TypeKindVisitor7
duke@1 79 * @since 1.6
duke@1 80 */
duke@1 81 @SupportedSourceVersion(RELEASE_6)
duke@1 82 public class TypeKindVisitor6<R, P> extends SimpleTypeVisitor6<R, P> {
duke@1 83 /**
duke@1 84 * Constructor for concrete subclasses to call; uses {@code null}
duke@1 85 * for the default value.
duke@1 86 */
duke@1 87 protected TypeKindVisitor6() {
duke@1 88 super(null);
duke@1 89 }
duke@1 90
duke@1 91
duke@1 92 /**
duke@1 93 * Constructor for concrete subclasses to call; uses the argument
duke@1 94 * for the default value.
duke@1 95 *
duke@1 96 * @param defaultValue the value to assign to {@link #DEFAULT_VALUE}
duke@1 97 */
duke@1 98 protected TypeKindVisitor6(R defaultValue) {
duke@1 99 super(defaultValue);
duke@1 100 }
duke@1 101
duke@1 102 /**
duke@1 103 * Visits a primitive type, dispatching to the visit method for
duke@1 104 * the specific {@linkplain TypeKind kind} of primitive type:
duke@1 105 * {@code BOOLEAN}, {@code BYTE}, etc.
duke@1 106 *
duke@1 107 * @param t {@inheritDoc}
duke@1 108 * @param p {@inheritDoc}
duke@1 109 * @return the result of the kind-specific visit method
duke@1 110 */
duke@1 111 @Override
duke@1 112 public R visitPrimitive(PrimitiveType t, P p) {
duke@1 113 TypeKind k = t.getKind();
duke@1 114 switch (k) {
duke@1 115 case BOOLEAN:
duke@1 116 return visitPrimitiveAsBoolean(t, p);
duke@1 117
duke@1 118 case BYTE:
duke@1 119 return visitPrimitiveAsByte(t, p);
duke@1 120
duke@1 121 case SHORT:
duke@1 122 return visitPrimitiveAsShort(t, p);
duke@1 123
duke@1 124 case INT:
duke@1 125 return visitPrimitiveAsInt(t, p);
duke@1 126
duke@1 127 case LONG:
duke@1 128 return visitPrimitiveAsLong(t, p);
duke@1 129
duke@1 130 case CHAR:
duke@1 131 return visitPrimitiveAsChar(t, p);
duke@1 132
duke@1 133 case FLOAT:
duke@1 134 return visitPrimitiveAsFloat(t, p);
duke@1 135
duke@1 136 case DOUBLE:
duke@1 137 return visitPrimitiveAsDouble(t, p);
duke@1 138
duke@1 139 default:
duke@1 140 throw new AssertionError("Bad kind " + k + " for PrimitiveType" + t);
duke@1 141 }
duke@1 142 }
duke@1 143
duke@1 144 /**
duke@1 145 * Visits a {@code BOOLEAN} primitive type by calling
duke@1 146 * {@code defaultAction}.
duke@1 147 *
duke@1 148 * @param t the type to visit
duke@1 149 * @param p a visitor-specified parameter
duke@1 150 * @return the result of {@code defaultAction}
duke@1 151 */
duke@1 152 public R visitPrimitiveAsBoolean(PrimitiveType t, P p) {
duke@1 153 return defaultAction(t, p);
duke@1 154 }
duke@1 155
duke@1 156 /**
duke@1 157 * Visits a {@code BYTE} primitive type by calling
duke@1 158 * {@code defaultAction}.
duke@1 159 *
duke@1 160 * @param t the type to visit
duke@1 161 * @param p a visitor-specified parameter
duke@1 162 * @return the result of {@code defaultAction}
duke@1 163 */
duke@1 164 public R visitPrimitiveAsByte(PrimitiveType t, P p) {
duke@1 165 return defaultAction(t, p);
duke@1 166 }
duke@1 167
duke@1 168 /**
duke@1 169 * Visits a {@code SHORT} primitive type by calling
duke@1 170 * {@code defaultAction}.
duke@1 171 *
duke@1 172 * @param t the type to visit
duke@1 173 * @param p a visitor-specified parameter
duke@1 174 * @return the result of {@code defaultAction}
duke@1 175 */
duke@1 176 public R visitPrimitiveAsShort(PrimitiveType t, P p) {
duke@1 177 return defaultAction(t, p);
duke@1 178 }
duke@1 179
duke@1 180 /**
duke@1 181 * Visits an {@code INT} primitive type by calling
duke@1 182 * {@code defaultAction}.
duke@1 183 *
duke@1 184 * @param t the type to visit
duke@1 185 * @param p a visitor-specified parameter
duke@1 186 * @return the result of {@code defaultAction}
duke@1 187 */
duke@1 188 public R visitPrimitiveAsInt(PrimitiveType t, P p) {
duke@1 189 return defaultAction(t, p);
duke@1 190 }
duke@1 191
duke@1 192 /**
duke@1 193 * Visits a {@code LONG} primitive type by calling
duke@1 194 * {@code defaultAction}.
duke@1 195 *
duke@1 196 * @param t the type to visit
duke@1 197 * @param p a visitor-specified parameter
duke@1 198 * @return the result of {@code defaultAction}
duke@1 199 */
duke@1 200 public R visitPrimitiveAsLong(PrimitiveType t, P p) {
duke@1 201 return defaultAction(t, p);
duke@1 202 }
duke@1 203
duke@1 204 /**
duke@1 205 * Visits a {@code CHAR} primitive type by calling
duke@1 206 * {@code defaultAction}.
duke@1 207 *
duke@1 208 * @param t the type to visit
duke@1 209 * @param p a visitor-specified parameter
duke@1 210 * @return the result of {@code defaultAction}
duke@1 211 */
duke@1 212 public R visitPrimitiveAsChar(PrimitiveType t, P p) {
duke@1 213 return defaultAction(t, p);
duke@1 214 }
duke@1 215
duke@1 216 /**
duke@1 217 * Visits a {@code FLOAT} primitive type by calling
duke@1 218 * {@code defaultAction}.
duke@1 219 *
duke@1 220 * @param t the type to visit
duke@1 221 * @param p a visitor-specified parameter
duke@1 222 * @return the result of {@code defaultAction}
duke@1 223 */
duke@1 224 public R visitPrimitiveAsFloat(PrimitiveType t, P p) {
duke@1 225 return defaultAction(t, p);
duke@1 226 }
duke@1 227
duke@1 228 /**
duke@1 229 * Visits a {@code DOUBLE} primitive type by calling
duke@1 230 * {@code defaultAction}.
duke@1 231 *
duke@1 232 * @param t the type to visit
duke@1 233 * @param p a visitor-specified parameter
duke@1 234 * @return the result of {@code defaultAction}
duke@1 235 */
duke@1 236 public R visitPrimitiveAsDouble(PrimitiveType t, P p) {
duke@1 237 return defaultAction(t, p);
duke@1 238 }
duke@1 239
duke@1 240 /**
duke@1 241 * Visits a {@link NoType} instance, dispatching to the visit method for
duke@1 242 * the specific {@linkplain TypeKind kind} of pseudo-type:
duke@1 243 * {@code VOID}, {@code PACKAGE}, or {@code NONE}.
duke@1 244 *
duke@1 245 * @param t {@inheritDoc}
duke@1 246 * @param p {@inheritDoc}
duke@1 247 * @return the result of the kind-specific visit method
duke@1 248 */
duke@1 249 @Override
duke@1 250 public R visitNoType(NoType t, P p) {
duke@1 251 TypeKind k = t.getKind();
duke@1 252 switch (k) {
duke@1 253 case VOID:
duke@1 254 return visitNoTypeAsVoid(t, p);
duke@1 255
duke@1 256 case PACKAGE:
duke@1 257 return visitNoTypeAsPackage(t, p);
duke@1 258
duke@1 259 case NONE:
duke@1 260 return visitNoTypeAsNone(t, p);
duke@1 261
duke@1 262 default:
duke@1 263 throw new AssertionError("Bad kind " + k + " for NoType" + t);
duke@1 264 }
duke@1 265 }
duke@1 266
duke@1 267 /**
duke@1 268 * Visits a {@link TypeKind#VOID VOID} pseudo-type by calling
duke@1 269 * {@code defaultAction}.
duke@1 270 *
duke@1 271 * @param t the type to visit
duke@1 272 * @param p a visitor-specified parameter
duke@1 273 * @return the result of {@code defaultAction}
duke@1 274 */
duke@1 275 public R visitNoTypeAsVoid(NoType t, P p) {
duke@1 276 return defaultAction(t, p);
duke@1 277 }
duke@1 278
duke@1 279 /**
duke@1 280 * Visits a {@link TypeKind#PACKAGE PACKAGE} pseudo-type by calling
duke@1 281 * {@code defaultAction}.
duke@1 282 *
duke@1 283 * @param t the type to visit
duke@1 284 * @param p a visitor-specified parameter
duke@1 285 * @return the result of {@code defaultAction}
duke@1 286 */
duke@1 287 public R visitNoTypeAsPackage(NoType t, P p) {
duke@1 288 return defaultAction(t, p);
duke@1 289 }
duke@1 290
duke@1 291 /**
duke@1 292 * Visits a {@link TypeKind#NONE NONE} pseudo-type by calling
duke@1 293 * {@code defaultAction}.
duke@1 294 *
duke@1 295 * @param t the type to visit
duke@1 296 * @param p a visitor-specified parameter
duke@1 297 * @return the result of {@code defaultAction}
duke@1 298 */
duke@1 299 public R visitNoTypeAsNone(NoType t, P p) {
duke@1 300 return defaultAction(t, p);
duke@1 301 }
duke@1 302 }

mercurial