001/* AnnotationTypeMismatchException.java - Thrown when annotation has changed
002   Copyright (C) 2004, 2005 Free Software Foundation
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038package java.lang.annotation;
039
040import java.lang.reflect.Method;
041
042/**
043 * Thrown when accessing an element within an annotation for
044 * which the type has changed, since compilation or serialization
045 * took place.  The mismatch between the compiled or serialized
046 * type and the current type causes this exception to be thrown.
047 * 
048 * @author Tom Tromey (tromey@redhat.com)
049 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
050 * @since 1.5
051 */
052public class AnnotationTypeMismatchException extends RuntimeException
053{
054
055  /**
056   * For compatability with Sun's JDK
057   */
058  private static final long serialVersionUID = 8125925355765570191L;
059
060  /**
061   * Constructs an <code>AnnotationTypeMismatchException</code>
062   * which is due to a mismatched type in the annotation
063   * element, <code>m</code>. The erroneous type used for the
064   * data in <code>m</code> is represented by the string,
065   * <code>type</code>.  This string is of an undefined format,
066   * and may contain the value as well as the type.
067   *
068   * @param m the element from the annotation.
069   * @param type the name of the erroneous type found in <code>m</code>.
070   */
071  public AnnotationTypeMismatchException(Method m, String type)
072  {
073    this.element = m;
074    this.foundType = type;
075  }
076
077  /**
078   * Returns the element from the annotation, for which a
079   * mismatch occurred.
080   *
081   * @return the element with the mismatched type.
082   */
083  public Method element()
084  {
085    return element;
086  }
087
088  /**
089   * Returns the erroneous type used by the element,
090   * represented as a <code>String</code>.  The format
091   * of this <code>String</code> is not explicitly specified,
092   * and may contain the value as well as the type.
093   *
094   * @return the type found in the element.
095   */
096  public String foundType()
097  {
098    return foundType;
099  }
100
101  // Names are chosen from serialization spec.
102  /**
103   * The element from the annotation.
104   *
105   * @serial the element with the mismatched type.
106   */
107  private Method element;
108
109  /**
110   * The erroneous type used by the element.
111   *
112   * @serial the type found in the element.
113   */
114  private String foundType;
115
116}