duke@1: /*
ohair@554:  * Copyright (c) 2005, 2009, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package javax.lang.model.type;
duke@1: 
darcy@216: import javax.lang.model.UnknownEntityException;
darcy@216: 
duke@1: /**
duke@1:  * Indicates that an unknown kind of type was encountered.  This can
duke@1:  * occur if the language evolves and new kinds of types are added to
duke@1:  * the {@code TypeMirror} hierarchy.  May be thrown by a {@linkplain
duke@1:  * TypeVisitor type visitor} to indicate that the visitor was created
duke@1:  * for a prior version of the language.
duke@1:  *
duke@1:  * @author Joseph D. Darcy
duke@1:  * @author Scott Seligman
duke@1:  * @author Peter von der Ahé
duke@1:  * @see TypeVisitor#visitUnknown
duke@1:  * @since 1.6
duke@1:  */
darcy@216: public class UnknownTypeException extends UnknownEntityException {
duke@1: 
duke@1:     private static final long serialVersionUID = 269L;
duke@1: 
duke@1:     private transient TypeMirror type;
duke@1:     private transient Object parameter;
duke@1: 
duke@1:     /**
duke@1:      * Creates a new {@code UnknownTypeException}.The {@code p}
duke@1:      * parameter may be used to pass in an additional argument with
duke@1:      * information about the context in which the unknown type was
duke@1:      * encountered; for example, the visit methods of {@link
duke@1:      * TypeVisitor} may pass in their additional parameter.
duke@1:      *
duke@1:      * @param t the unknown type, may be {@code null}
duke@1:      * @param p an additional parameter, may be {@code null}
duke@1:      */
duke@1:     public UnknownTypeException(TypeMirror t, Object p) {
duke@1:         super("Unknown type: " + t);
duke@1:         type = t;
duke@1:         this.parameter = p;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Returns the unknown type.
duke@1:      * The value may be unavailable if this exception has been
duke@1:      * serialized and then read back in.
duke@1:      *
duke@1:      * @return the unknown type, or {@code null} if unavailable
duke@1:      */
duke@1:     public TypeMirror getUnknownType() {
duke@1:         return type;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Returns the additional argument.
duke@1:      *
duke@1:      * @return the additional argument
duke@1:      */
duke@1:     public Object getArgument() {
duke@1:         return parameter;
duke@1:     }
duke@1: }