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

     1 /*
     2  * Copyright 2005-2009 Sun Microsystems, Inc.  All Rights Reserved.
     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4  *
     5  * This code is free software; you can redistribute it and/or modify it
     6  * under the terms of the GNU General Public License version 2 only, as
     7  * published by the Free Software Foundation.  Sun designates this
     8  * particular file as subject to the "Classpath" exception as provided
     9  * by Sun in the LICENSE file that accompanied this code.
    10  *
    11  * This code is distributed in the hope that it will be useful, but WITHOUT
    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    14  * version 2 for more details (a copy is included in the LICENSE file that
    15  * accompanied this code).
    16  *
    17  * You should have received a copy of the GNU General Public License version
    18  * 2 along with this work; if not, write to the Free Software Foundation,
    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    20  *
    21  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    22  * CA 95054 USA or visit www.sun.com if you need additional information or
    23  * have any questions.
    24  */
    26 package javax.lang.model.type;
    28 import javax.lang.model.UnknownEntityException;
    30 /**
    31  * Indicates that an unknown kind of type was encountered.  This can
    32  * occur if the language evolves and new kinds of types are added to
    33  * the {@code TypeMirror} hierarchy.  May be thrown by a {@linkplain
    34  * TypeVisitor type visitor} to indicate that the visitor was created
    35  * for a prior version of the language.
    36  *
    37  * @author Joseph D. Darcy
    38  * @author Scott Seligman
    39  * @author Peter von der Ahé
    40  * @see TypeVisitor#visitUnknown
    41  * @since 1.6
    42  */
    43 public class UnknownTypeException extends UnknownEntityException {
    45     private static final long serialVersionUID = 269L;
    47     private transient TypeMirror type;
    48     private transient Object parameter;
    50     /**
    51      * Creates a new {@code UnknownTypeException}.The {@code p}
    52      * parameter may be used to pass in an additional argument with
    53      * information about the context in which the unknown type was
    54      * encountered; for example, the visit methods of {@link
    55      * TypeVisitor} may pass in their additional parameter.
    56      *
    57      * @param t the unknown type, may be {@code null}
    58      * @param p an additional parameter, may be {@code null}
    59      */
    60     public UnknownTypeException(TypeMirror t, Object p) {
    61         super("Unknown type: " + t);
    62         type = t;
    63         this.parameter = p;
    64     }
    66     /**
    67      * Returns the unknown type.
    68      * The value may be unavailable if this exception has been
    69      * serialized and then read back in.
    70      *
    71      * @return the unknown type, or {@code null} if unavailable
    72      */
    73     public TypeMirror getUnknownType() {
    74         return type;
    75     }
    77     /**
    78      * Returns the additional argument.
    79      *
    80      * @return the additional argument
    81      */
    82     public Object getArgument() {
    83         return parameter;
    84     }
    85 }

mercurial