1 /*
   2  * Copyright 2004 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  */
  25 
  26 package com.sun.mirror.type;
  27 
  28 
  29 import java.lang.annotation.Annotation;
  30 
  31 import com.sun.mirror.declaration.Declaration;
  32 
  33 
  34 /**
  35  * Thrown when an application attempts to access the {@link Class} object
  36  * corresponding to a {@link TypeMirror}.
  37  *
  38  * @see MirroredTypesException
  39  * @see Declaration#getAnnotation(Class)
  40  */
  41 public class MirroredTypeException extends RuntimeException {
  42 
  43     private static final long serialVersionUID = 1;
  44 
  45     private transient TypeMirror type;          // cannot be serialized
  46     private String name;                        // type's qualified "name"
  47 
  48     /**
  49      * Constructs a new MirroredTypeException for the specified type.
  50      *
  51      * @param type  the type being accessed
  52      */
  53     public MirroredTypeException(TypeMirror type) {
  54         super("Attempt to access Class object for TypeMirror " + type);
  55         this.type = type;
  56         name = type.toString();
  57     }
  58 
  59     /**
  60      * Returns the type mirror corresponding to the type being accessed.
  61      * The type mirror may be unavailable if this exception has been
  62      * serialized and then read back in.
  63      *
  64      * @return the type mirror, or <tt>null</tt> if unavailable
  65      */
  66     public TypeMirror getTypeMirror() {
  67         return type;
  68     }
  69 
  70     /**
  71      * Returns the fully qualified name of the type being accessed.
  72      * More precisely, returns the canonical name of a class,
  73      * interface, array, or primitive, and returns <tt>"void"</tt> for
  74      * the pseudo-type representing the type of <tt>void</tt>.
  75      *
  76      * @return the fully qualified name of the type being accessed
  77      */
  78     public String getQualifiedName() {
  79         return name;
  80     }
  81 }