src/share/classes/javax/lang/model/type/UnknownTypeException.java

Fri, 06 Feb 2009 12:49:48 -0800

author
darcy
date
Fri, 06 Feb 2009 12:49:48 -0800
changeset 216
58fcba61a77d
parent 1
9a66ca7c79fa
child 554
9d9f26857129
permissions
-rw-r--r--

6794071: Provide exception superclass for UnknownFooExceptions
Reviewed-by: jjg

duke@1 1 /*
darcy@216 2 * Copyright 2005-2009 Sun Microsystems, Inc. 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
duke@1 7 * published by the Free Software Foundation. Sun designates this
duke@1 8 * particular file as subject to the "Classpath" exception as provided
duke@1 9 * by Sun 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 *
duke@1 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1 22 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1 23 * have any questions.
duke@1 24 */
duke@1 25
duke@1 26 package javax.lang.model.type;
duke@1 27
darcy@216 28 import javax.lang.model.UnknownEntityException;
darcy@216 29
duke@1 30 /**
duke@1 31 * Indicates that an unknown kind of type was encountered. This can
duke@1 32 * occur if the language evolves and new kinds of types are added to
duke@1 33 * the {@code TypeMirror} hierarchy. May be thrown by a {@linkplain
duke@1 34 * TypeVisitor type visitor} to indicate that the visitor was created
duke@1 35 * for a prior version of the language.
duke@1 36 *
duke@1 37 * @author Joseph D. Darcy
duke@1 38 * @author Scott Seligman
duke@1 39 * @author Peter von der Ahé
duke@1 40 * @see TypeVisitor#visitUnknown
duke@1 41 * @since 1.6
duke@1 42 */
darcy@216 43 public class UnknownTypeException extends UnknownEntityException {
duke@1 44
duke@1 45 private static final long serialVersionUID = 269L;
duke@1 46
duke@1 47 private transient TypeMirror type;
duke@1 48 private transient Object parameter;
duke@1 49
duke@1 50 /**
duke@1 51 * Creates a new {@code UnknownTypeException}.The {@code p}
duke@1 52 * parameter may be used to pass in an additional argument with
duke@1 53 * information about the context in which the unknown type was
duke@1 54 * encountered; for example, the visit methods of {@link
duke@1 55 * TypeVisitor} may pass in their additional parameter.
duke@1 56 *
duke@1 57 * @param t the unknown type, may be {@code null}
duke@1 58 * @param p an additional parameter, may be {@code null}
duke@1 59 */
duke@1 60 public UnknownTypeException(TypeMirror t, Object p) {
duke@1 61 super("Unknown type: " + t);
duke@1 62 type = t;
duke@1 63 this.parameter = p;
duke@1 64 }
duke@1 65
duke@1 66 /**
duke@1 67 * Returns the unknown type.
duke@1 68 * The value may be unavailable if this exception has been
duke@1 69 * serialized and then read back in.
duke@1 70 *
duke@1 71 * @return the unknown type, or {@code null} if unavailable
duke@1 72 */
duke@1 73 public TypeMirror getUnknownType() {
duke@1 74 return type;
duke@1 75 }
duke@1 76
duke@1 77 /**
duke@1 78 * Returns the additional argument.
duke@1 79 *
duke@1 80 * @return the additional argument
duke@1 81 */
duke@1 82 public Object getArgument() {
duke@1 83 return parameter;
duke@1 84 }
duke@1 85 }

mercurial