Source for java.lang.annotation.IncompleteAnnotationException

   1: /* IncompleteAnnotationException.java - Thrown when annotation has changed
   2:    Copyright (C) 2004 Free Software Foundation
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: package java.lang.annotation;
  39: 
  40: /**
  41:  * Thrown when accessing an element within an annotation which
  42:  * was added since compilation or serialization took place, and
  43:  * does not have a default value.  
  44:  * 
  45:  * @author Tom Tromey (tromey@redhat.com)
  46:  * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
  47:  * @since 1.5
  48:  */
  49: public class IncompleteAnnotationException extends RuntimeException
  50: {
  51: 
  52:   /**
  53:    * Constructs a new <code>IncompleteAnnotationException</code>
  54:    * which indicates that the element, <code>name</code>, was missing
  55:    * from the annotation, <code>type</code> at compile time and does
  56:    * not have a default value.
  57:    *
  58:    * @param type the type of annotation from which an element is missing.
  59:    * @param name the name of the missing element.
  60:    */
  61:   public IncompleteAnnotationException(Class<? extends Annotation> type,
  62:                        String name)
  63:   {
  64:     this.annotationType = type;
  65:     this.elementName = name;
  66:   }
  67: 
  68:   /**
  69:    * Returns the class representing the type of annotation
  70:    * from which an element was missing.
  71:    *
  72:    * @return the type of annotation.
  73:    */
  74:   public Class<? extends Annotation> annotationType()
  75:   {
  76:     return annotationType;
  77:   }
  78: 
  79:   /**
  80:    * Returns the name of the missing annotation element.
  81:    *
  82:    * @return the element name.
  83:    */
  84:   public String elementName()
  85:   {
  86:     return elementName;
  87:   }
  88: 
  89:   // Names are chosen from serialization spec.
  90: 
  91:   /**
  92:    * The class representing the type of annotation from
  93:    * which an element was found to be missing.
  94:    *
  95:    * @serial the type of the annotation from which an
  96:    *         element was missing.
  97:    */
  98:   private Class<? extends Annotation> annotationType;
  99: 
 100:   /**
 101:    * The name of the missing element.
 102:    *
 103:    * @serial the name of the missing element. 
 104:    */
 105:   private String elementName;
 106: 
 107: }