1 /*
2 * Copyright 2003-2005 Sun Microsystems, Inc. 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. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package java.lang.reflect;
27
28 import java.lang.annotation.Annotation;
29
30 /**
31 * Represents an annotated element of the program currently running in this
32 * VM. This interface allows annotations to be read reflectively. All
33 * annotations returned by methods in this interface are immutable and
34 * serializable. It is permissible for the caller to modify the
35 * arrays returned by accessors for array-valued enum members; it will
36 * have no affect on the arrays returned to other callers.
37 *
38 * <p>If an annotation returned by a method in this interface contains
39 * (directly or indirectly) a {@link Class}-valued member referring to
40 * a class that is not accessible in this VM, attempting to read the class
41 * by calling the relevant Class-returning method on the returned annotation
42 * will result in a {@link TypeNotPresentException}.
43 *
44 * <p>Similarly, attempting to read an enum-valued member will result in
45 * a {@link EnumConstantNotPresentException} if the enum constant in the
46 * annotation is no longer present in the enum type.
47 *
48 * <p>Finally, Attempting to read a member whose definition has evolved
49 * incompatibly will result in a {@link
50 * java.lang.annotation.AnnotationTypeMismatchException} or an
51 * {@link java.lang.annotation.IncompleteAnnotationException}.
52 *
53 * @since 1.5
54 * @author Josh Bloch
55 */
56 public interface AnnotatedElement {
57 /**
58 * Returns true if an annotation for the specified type
59 * is present on this element, else false. This method
60 * is designed primarily for convenient access to marker annotations.
61 *
62 * @param annotationClass the Class object corresponding to the
63 * annotation type
64 * @return true if an annotation for the specified annotation
65 * type is present on this element, else false
66 * @throws NullPointerException if the given annotation class is null
67 * @since 1.5
68 */
69 boolean isAnnotationPresent(Class<? extends Annotation> annotationClass);
70
71 /**
72 * Returns this element's annotation for the specified type if
73 * such an annotation is present, else null.
74 *
75 * @param annotationClass the Class object corresponding to the
76 * annotation type
77 * @return this element's annotation for the specified annotation type if
78 * present on this element, else null
79 * @throws NullPointerException if the given annotation class is null
80 * @since 1.5
81 */
82 <T extends Annotation> T getAnnotation(Class<T> annotationClass);
83
84 /**
85 * Returns all annotations present on this element. (Returns an array
86 * of length zero if this element has no annotations.) The caller of
87 * this method is free to modify the returned array; it will have no
88 * effect on the arrays returned to other callers.
89 *
90 * @return all annotations present on this element
91 * @since 1.5
92 */
93 Annotation[] getAnnotations();
94
95 /**
96 * Returns all annotations that are directly present on this
97 * element. Unlike the other methods in this interface, this method
98 * ignores inherited annotations. (Returns an array of length zero if
99 * no annotations are directly present on this element.) The caller of
100 * this method is free to modify the returned array; it will have no
101 * effect on the arrays returned to other callers.
102 *
103 * @return All annotations directly present on this element
104 * @since 1.5
105 */
106 Annotation[] getDeclaredAnnotations();
107 }
Save This Page