1 /*
   2  * Copyright (c) 2003, 2016, Oracle and/or its affiliates. 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.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package java.lang.annotation;
  27 import java.lang.reflect.Method;
  28 
  29 /**
  30  * Thrown to indicate that a program has attempted to access an element of
  31  * an annotation whose type has changed after the annotation was compiled
  32  * (or serialized).
  33  * This exception can be thrown by the {@linkplain
  34  * java.lang.reflect.AnnotatedElement API used to read annotations
  35  * reflectively}.
  36  *
  37  * @author  Josh Bloch
  38  * @see     java.lang.reflect.AnnotatedElement
  39  * @since 1.5
  40  */
  41 public class AnnotationTypeMismatchException extends RuntimeException {
  42     @java.io.Serial
  43     private static final long serialVersionUID = 8125925355765570191L;
  44 
  45     /**
  46      * The {@code Method} object for the annotation element.
  47      */
  48     private final transient Method element;
  49 
  50     /**
  51      * The (erroneous) type of data found in the annotation.  This string
  52      * may, but is not required to, contain the value as well.  The exact
  53      * format of the string is unspecified.
  54      */
  55     private final String foundType;
  56 
  57     /**
  58      * Constructs an AnnotationTypeMismatchException for the specified
  59      * annotation type element and found data type.
  60      *
  61      * @param element the {@code Method} object for the annotation
  62      * element, may be {@code null}
  63      * @param foundType the (erroneous) type of data found in the annotation.
  64      *        This string may, but is not required to, contain the value
  65      *        as well.  The exact format of the string is unspecified,
  66      *        may be {@code null}.
  67      */
  68     public AnnotationTypeMismatchException(Method element, String foundType) {
  69         super("Incorrectly typed data found for annotation element " + element
  70               + " (Found data of type " + foundType + ")");
  71         this.element = element;
  72         this.foundType = foundType;
  73     }
  74 
  75     /**
  76      * Returns the {@code Method} object for the incorrectly typed element.
  77      * The value may be unavailable if this exception has been
  78      * serialized and then read back in.
  79      *
  80      * @return the {@code Method} object for the incorrectly typed
  81      * element, or {@code null} if unavailable
  82      */
  83     public Method element() {
  84         return this.element;
  85     }
  86 
  87     /**
  88      * Returns the type of data found in the incorrectly typed element.
  89      * The returned string may, but is not required to, contain the value
  90      * as well.  The exact format of the string is unspecified and the string
  91      * may be {@code null}.
  92      *
  93      * @return the type of data found in the incorrectly typed element
  94      */
  95     public String foundType() {
  96         return this.foundType;
  97     }
  98 }