AnnotationTypeMismatchException.java revision 51b1b6997fd3f980076b8081f7f1165ccc2a4008 
1/*
2 * Copyright (c) 2003, 2008, 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
26package java.lang.annotation;
27import 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 */
41public class AnnotationTypeMismatchException extends RuntimeException {
42    private static final long serialVersionUID = 8125925355765570191L;
43
44    /**
45     * The <tt>Method</tt> object for the annotation element.
46     */
47    private final Method element;
48
49    /**
50     * The (erroneous) type of data found in the annotation.  This string
51     * may, but is not required to, contain the value as well.  The exact
52     * format of the string is unspecified.
53     */
54    private final String foundType;
55
56    /**
57     * Constructs an AnnotationTypeMismatchException for the specified
58     * annotation type element and found data type.
59     *
60     * @param element the <tt>Method</tt> object for the annotation element
61     * @param foundType the (erroneous) type of data found in the annotation.
62     *        This string may, but is not required to, contain the value
63     *        as well.  The exact format of the string is unspecified.
64     */
65    public AnnotationTypeMismatchException(Method element, String foundType) {
66        super("Incorrectly typed data found for annotation element " + element
67              + " (Found data of type " + foundType + ")");
68        this.element = element;
69        this.foundType = foundType;
70    }
71
72    /**
73     * Returns the <tt>Method</tt> object for the incorrectly typed element.
74     *
75     * @return the <tt>Method</tt> object for the incorrectly typed element
76     */
77    public Method element() {
78        return this.element;
79    }
80
81    /**
82     * Returns the type of data found in the incorrectly typed element.
83     * The returned string may, but is not required to, contain the value
84     * as well.  The exact format of the string is unspecified.
85     *
86     * @return the type of data found in the incorrectly typed element
87     */
88    public String foundType() {
89        return this.foundType;
90    }
91}
92