1 /*
   2  * Copyright 2004-2005 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 import java.util.ArrayList;
  31 import java.util.Collection;
  32 import java.util.Collections;
  33 
  34 import com.sun.mirror.declaration.Declaration;
  35 
  36 
  37 /**
  38  * Thrown when an application attempts to access a sequence of {@link Class}
  39  * objects each corresponding to a {@link TypeMirror}.
  40  *
  41  * @see MirroredTypeException
  42  * @see Declaration#getAnnotation(Class)
  43  */
  44 public class MirroredTypesException extends RuntimeException {
  45 
  46     private static final long serialVersionUID = 1;
  47 
  48     private transient Collection<TypeMirror> types;     // cannot be serialized
  49     private Collection<String> names;           // types' qualified "names"
  50 
  51     /**
  52      * Constructs a new MirroredTypesException for the specified types.
  53      *
  54      * @param types  an ordered collection of the types being accessed
  55      */
  56     public MirroredTypesException(Collection<TypeMirror> types) {
  57         super("Attempt to access Class objects for TypeMirrors " + types);
  58         this.types = types;
  59         names = new ArrayList<String>();
  60         for (TypeMirror t : types) {
  61             names.add(t.toString());
  62         }
  63     }
  64 
  65     /**
  66      * Returns the type mirrors corresponding to the types being accessed.
  67      * The type mirrors may be unavailable if this exception has been
  68      * serialized and then read back in.
  69      *
  70      * @return the type mirrors in order, or <tt>null</tt> if unavailable
  71      */
  72     public Collection<TypeMirror> getTypeMirrors() {
  73         return (types != null)
  74                 ? Collections.unmodifiableCollection(types)
  75                 : null;
  76     }
  77 
  78     /**
  79      * Returns the fully qualified names of the types being accessed.
  80      * More precisely, returns the canonical names of each class,
  81      * interface, array, or primitive, and <tt>"void"</tt> for
  82      * the pseudo-type representing the type of <tt>void</tt>.
  83      *
  84      * @return the fully qualified names, in order, of the types being
  85      *          accessed
  86      */
  87     public Collection<String> getQualifiedNames() {
  88         return Collections.unmodifiableCollection(names);
  89     }
  90 }