rt/emul/compact/src/main/java/java/lang/annotation/IncompleteAnnotationException.java
author Jaroslav Tulach <jtulach@netbeans.org>
Mon, 21 Oct 2013 14:38:36 +0200
branchjdk7-b147
changeset 1379 b5f9d743a090
permissions -rw-r--r--
Adding annotation classes into the emulation layer
jtulach@1379
     1
/*
jtulach@1379
     2
 * Copyright (c) 2003, 2008, Oracle and/or its affiliates. All rights reserved.
jtulach@1379
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jtulach@1379
     4
 *
jtulach@1379
     5
 * This code is free software; you can redistribute it and/or modify it
jtulach@1379
     6
 * under the terms of the GNU General Public License version 2 only, as
jtulach@1379
     7
 * published by the Free Software Foundation.  Oracle designates this
jtulach@1379
     8
 * particular file as subject to the "Classpath" exception as provided
jtulach@1379
     9
 * by Oracle in the LICENSE file that accompanied this code.
jtulach@1379
    10
 *
jtulach@1379
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
jtulach@1379
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jtulach@1379
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
jtulach@1379
    14
 * version 2 for more details (a copy is included in the LICENSE file that
jtulach@1379
    15
 * accompanied this code).
jtulach@1379
    16
 *
jtulach@1379
    17
 * You should have received a copy of the GNU General Public License version
jtulach@1379
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
jtulach@1379
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jtulach@1379
    20
 *
jtulach@1379
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
jtulach@1379
    22
 * or visit www.oracle.com if you need additional information or have any
jtulach@1379
    23
 * questions.
jtulach@1379
    24
 */
jtulach@1379
    25
jtulach@1379
    26
package java.lang.annotation;
jtulach@1379
    27
jtulach@1379
    28
/**
jtulach@1379
    29
 * Thrown to indicate that a program has attempted to access an element of
jtulach@1379
    30
 * an annotation type that was added to the annotation type definition after
jtulach@1379
    31
 * the annotation was compiled (or serialized).  This exception will not be
jtulach@1379
    32
 * thrown if the new element has a default value.
jtulach@1379
    33
 * This exception can be thrown by the {@linkplain
jtulach@1379
    34
 * java.lang.reflect.AnnotatedElement API used to read annotations
jtulach@1379
    35
 * reflectively}.
jtulach@1379
    36
 *
jtulach@1379
    37
 * @author  Josh Bloch
jtulach@1379
    38
 * @see     java.lang.reflect.AnnotatedElement
jtulach@1379
    39
 * @since 1.5
jtulach@1379
    40
 */
jtulach@1379
    41
public class IncompleteAnnotationException extends RuntimeException {
jtulach@1379
    42
    private static final long serialVersionUID = 8445097402741811912L;
jtulach@1379
    43
jtulach@1379
    44
    private Class annotationType;
jtulach@1379
    45
    private String elementName;
jtulach@1379
    46
jtulach@1379
    47
jtulach@1379
    48
    /**
jtulach@1379
    49
     * Constructs an IncompleteAnnotationException to indicate that
jtulach@1379
    50
     * the named element was missing from the specified annotation type.
jtulach@1379
    51
     *
jtulach@1379
    52
     * @param annotationType the Class object for the annotation type
jtulach@1379
    53
     * @param elementName the name of the missing element
jtulach@1379
    54
     */
jtulach@1379
    55
    public IncompleteAnnotationException(
jtulach@1379
    56
            Class<? extends Annotation> annotationType,
jtulach@1379
    57
            String elementName) {
jtulach@1379
    58
        super(annotationType.getName() + " missing element " + elementName);
jtulach@1379
    59
jtulach@1379
    60
        this.annotationType = annotationType;
jtulach@1379
    61
        this.elementName = elementName;
jtulach@1379
    62
    }
jtulach@1379
    63
jtulach@1379
    64
    /**
jtulach@1379
    65
     * Returns the Class object for the annotation type with the
jtulach@1379
    66
     * missing element.
jtulach@1379
    67
     *
jtulach@1379
    68
     * @return the Class object for the annotation type with the
jtulach@1379
    69
     *     missing element
jtulach@1379
    70
     */
jtulach@1379
    71
    public Class<? extends Annotation> annotationType() {
jtulach@1379
    72
        return annotationType;
jtulach@1379
    73
    }
jtulach@1379
    74
jtulach@1379
    75
    /**
jtulach@1379
    76
     * Returns the name of the missing element.
jtulach@1379
    77
     *
jtulach@1379
    78
     * @return the name of the missing element
jtulach@1379
    79
     */
jtulach@1379
    80
    public String elementName() {
jtulach@1379
    81
        return elementName;
jtulach@1379
    82
    }
jtulach@1379
    83
}