1 /*
2  * Copyright (c) 2003, 2020, 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 
28 /**
29  * Thrown to indicate that a program has attempted to access an element of
30  * an annotation interface that was added to the annotation interface definition
31  * after the annotation was compiled (or serialized). This exception will not be
32  * thrown if the new element has a default value.
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 IncompleteAnnotationException extends RuntimeException {
42     @java.io.Serial
43     private static final long serialVersionUID = 8445097402741811912L;
44 
45     /**
46      * The annotation interface.
47      */
48     private Class<? extends Annotation> annotationType;
49     /**
50      * The element name.
51      */
52     private String elementName;
53 
54     /**
55      * Constructs an IncompleteAnnotationException to indicate that
56      * the named element was missing from the specified annotation interface.
57      *
58      * @param annotationType the Class object for the annotation interface
59      * @param elementName the name of the missing element
60      * @throws NullPointerException if either parameter is {@code null}
61      */
IncompleteAnnotationException( Class<? extends Annotation> annotationType, String elementName)62     public IncompleteAnnotationException(
63             Class<? extends Annotation> annotationType,
64             String elementName) {
65         super(annotationType.getName() + " missing element " +
66               elementName.toString());
67 
68         this.annotationType = annotationType;
69         this.elementName = elementName;
70     }
71 
72     /**
73      * Returns the Class object for the annotation interface with the
74      * missing element.
75      *
76      * @return the Class object for the annotation interface with the
77      *     missing element
78      */
annotationType()79     public Class<? extends Annotation> annotationType() {
80         return annotationType;
81     }
82 
83     /**
84      * Returns the name of the missing element.
85      *
86      * @return the name of the missing element
87      */
elementName()88     public String elementName() {
89         return elementName;
90     }
91 }
92