jtulach@1379: /*
jtulach@1379:  * Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved.
jtulach@1379:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jtulach@1379:  *
jtulach@1379:  * This code is free software; you can redistribute it and/or modify it
jtulach@1379:  * under the terms of the GNU General Public License version 2 only, as
jtulach@1379:  * published by the Free Software Foundation.  Oracle designates this
jtulach@1379:  * particular file as subject to the "Classpath" exception as provided
jtulach@1379:  * by Oracle in the LICENSE file that accompanied this code.
jtulach@1379:  *
jtulach@1379:  * This code is distributed in the hope that it will be useful, but WITHOUT
jtulach@1379:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jtulach@1379:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
jtulach@1379:  * version 2 for more details (a copy is included in the LICENSE file that
jtulach@1379:  * accompanied this code).
jtulach@1379:  *
jtulach@1379:  * You should have received a copy of the GNU General Public License version
jtulach@1379:  * 2 along with this work; if not, write to the Free Software Foundation,
jtulach@1379:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jtulach@1379:  *
jtulach@1379:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
jtulach@1379:  * or visit www.oracle.com if you need additional information or have any
jtulach@1379:  * questions.
jtulach@1379:  */
jtulach@1379: 
jtulach@1379: package java.lang.annotation;
jtulach@1379: 
jtulach@1379: /**
jtulach@1379:  * Thrown to indicate that a program has attempted to access an element of
jtulach@1379:  * an annotation type that was added to the annotation type definition after
jtulach@1379:  * the annotation was compiled (or serialized).  This exception will not be
jtulach@1379:  * thrown if the new element has a default value.
jtulach@1379:  * This exception can be thrown by the {@linkplain
jtulach@1379:  * java.lang.reflect.AnnotatedElement API used to read annotations
jtulach@1379:  * reflectively}.
jtulach@1379:  *
jtulach@1379:  * @author  Josh Bloch
jtulach@1379:  * @see     java.lang.reflect.AnnotatedElement
jtulach@1379:  * @since 1.5
jtulach@1379:  */
jtulach@1379: public class IncompleteAnnotationException extends RuntimeException {
jtulach@1379:     private static final long serialVersionUID = 8445097402741811912L;
jtulach@1379: 
jtulach@1379:     private Class annotationType;
jtulach@1379:     private String elementName;
jtulach@1379: 
jtulach@1379: 
jtulach@1379:     /**
jtulach@1379:      * Constructs an IncompleteAnnotationException to indicate that
jtulach@1379:      * the named element was missing from the specified annotation type.
jtulach@1379:      *
jtulach@1379:      * @param annotationType the Class object for the annotation type
jtulach@1379:      * @param elementName the name of the missing element
jtulach@1379:      */
jtulach@1379:     public IncompleteAnnotationException(
jtulach@1379:             Class<? extends Annotation> annotationType,
jtulach@1379:             String elementName) {
jtulach@1379:         super(annotationType.getName() + " missing element " + elementName);
jtulach@1379: 
jtulach@1379:         this.annotationType = annotationType;
jtulach@1379:         this.elementName = elementName;
jtulach@1379:     }
jtulach@1379: 
jtulach@1379:     /**
jtulach@1379:      * Returns the Class object for the annotation type with the
jtulach@1379:      * missing element.
jtulach@1379:      *
jtulach@1379:      * @return the Class object for the annotation type with the
jtulach@1379:      *     missing element
jtulach@1379:      */
jtulach@1379:     public Class<? extends Annotation> annotationType() {
jtulach@1379:         return annotationType;
jtulach@1379:     }
jtulach@1379: 
jtulach@1379:     /**
jtulach@1379:      * Returns the name of the missing element.
jtulach@1379:      *
jtulach@1379:      * @return the name of the missing element
jtulach@1379:      */
jtulach@1379:     public String elementName() {
jtulach@1379:         return elementName;
jtulach@1379:     }
jtulach@1379: }