Mon, 14 Jan 2013 19:52:36 +0100
7193719: Support repeating annotations in javax.lang.model
Reviewed-by: jjg
duke@1 | 1 | /* |
jfranck@1491 | 2 | * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package javax.lang.model.element; |
duke@1 | 27 | |
duke@1 | 28 | |
duke@1 | 29 | import java.lang.annotation.Annotation; |
duke@1 | 30 | import java.lang.annotation.AnnotationTypeMismatchException; |
duke@1 | 31 | import java.lang.annotation.IncompleteAnnotationException; |
duke@1 | 32 | import java.util.List; |
duke@1 | 33 | import java.util.Set; |
duke@1 | 34 | |
duke@1 | 35 | import javax.lang.model.type.*; |
duke@1 | 36 | import javax.lang.model.util.*; |
duke@1 | 37 | |
duke@1 | 38 | |
duke@1 | 39 | /** |
duke@1 | 40 | * Represents a program element such as a package, class, or method. |
duke@1 | 41 | * Each element represents a static, language-level construct |
duke@1 | 42 | * (and not, for example, a runtime construct of the virtual machine). |
duke@1 | 43 | * |
duke@1 | 44 | * <p> Elements should be compared using the {@link #equals(Object)} |
duke@1 | 45 | * method. There is no guarantee that any particular element will |
duke@1 | 46 | * always be represented by the same object. |
duke@1 | 47 | * |
duke@1 | 48 | * <p> To implement operations based on the class of an {@code |
duke@1 | 49 | * Element} object, either use a {@linkplain ElementVisitor visitor} or |
duke@1 | 50 | * use the result of the {@link #getKind} method. Using {@code |
duke@1 | 51 | * instanceof} is <em>not</em> necessarily a reliable idiom for |
duke@1 | 52 | * determining the effective class of an object in this modeling |
duke@1 | 53 | * hierarchy since an implementation may choose to have a single object |
duke@1 | 54 | * implement multiple {@code Element} subinterfaces. |
duke@1 | 55 | * |
duke@1 | 56 | * @author Joseph D. Darcy |
duke@1 | 57 | * @author Scott Seligman |
duke@1 | 58 | * @author Peter von der Ahé |
duke@1 | 59 | * @see Elements |
duke@1 | 60 | * @see TypeMirror |
duke@1 | 61 | * @since 1.6 |
duke@1 | 62 | */ |
duke@1 | 63 | public interface Element { |
duke@1 | 64 | |
duke@1 | 65 | /** |
duke@1 | 66 | * Returns the type defined by this element. |
duke@1 | 67 | * |
duke@1 | 68 | * <p> A generic element defines a family of types, not just one. |
duke@1 | 69 | * If this is a generic element, a <i>prototypical</i> type is |
duke@1 | 70 | * returned. This is the element's invocation on the |
duke@1 | 71 | * type variables corresponding to its own formal type parameters. |
duke@1 | 72 | * For example, |
duke@1 | 73 | * for the generic class element {@code C<N extends Number>}, |
duke@1 | 74 | * the parameterized type {@code C<N>} is returned. |
duke@1 | 75 | * The {@link Types} utility interface has more general methods |
duke@1 | 76 | * for obtaining the full range of types defined by an element. |
duke@1 | 77 | * |
duke@1 | 78 | * @see Types |
duke@1 | 79 | * |
duke@1 | 80 | * @return the type defined by this element |
duke@1 | 81 | */ |
duke@1 | 82 | TypeMirror asType(); |
duke@1 | 83 | |
duke@1 | 84 | /** |
duke@1 | 85 | * Returns the {@code kind} of this element. |
duke@1 | 86 | * |
duke@1 | 87 | * @return the kind of this element |
duke@1 | 88 | */ |
duke@1 | 89 | ElementKind getKind(); |
duke@1 | 90 | |
duke@1 | 91 | /** |
duke@1 | 92 | * Returns the annotations that are directly present on this element. |
duke@1 | 93 | * |
duke@1 | 94 | * <p> To get inherited annotations as well, use |
duke@1 | 95 | * {@link Elements#getAllAnnotationMirrors(Element) getAllAnnotationMirrors}. |
duke@1 | 96 | * |
duke@1 | 97 | * @see ElementFilter |
duke@1 | 98 | * |
duke@1 | 99 | * @return the annotations directly present on this element; |
duke@1 | 100 | * an empty list if there are none |
duke@1 | 101 | */ |
duke@1 | 102 | List<? extends AnnotationMirror> getAnnotationMirrors(); |
duke@1 | 103 | |
duke@1 | 104 | /** |
duke@1 | 105 | * Returns this element's annotation for the specified type if |
duke@1 | 106 | * such an annotation is present, else {@code null}. The |
duke@1 | 107 | * annotation may be either inherited or directly present on this |
duke@1 | 108 | * element. |
duke@1 | 109 | * |
duke@1 | 110 | * <p> The annotation returned by this method could contain an element |
duke@1 | 111 | * whose value is of type {@code Class}. |
duke@1 | 112 | * This value cannot be returned directly: information necessary to |
duke@1 | 113 | * locate and load a class (such as the class loader to use) is |
duke@1 | 114 | * not available, and the class might not be loadable at all. |
duke@1 | 115 | * Attempting to read a {@code Class} object by invoking the relevant |
duke@1 | 116 | * method on the returned annotation |
duke@1 | 117 | * will result in a {@link MirroredTypeException}, |
duke@1 | 118 | * from which the corresponding {@link TypeMirror} may be extracted. |
duke@1 | 119 | * Similarly, attempting to read a {@code Class[]}-valued element |
duke@1 | 120 | * will result in a {@link MirroredTypesException}. |
duke@1 | 121 | * |
duke@1 | 122 | * <blockquote> |
duke@1 | 123 | * <i>Note:</i> This method is unlike others in this and related |
duke@1 | 124 | * interfaces. It operates on runtime reflective information — |
duke@1 | 125 | * representations of annotation types currently loaded into the |
duke@1 | 126 | * VM — rather than on the representations defined by and used |
duke@1 | 127 | * throughout these interfaces. Consequently, calling methods on |
duke@1 | 128 | * the returned annotation object can throw many of the exceptions |
duke@1 | 129 | * that can be thrown when calling methods on an annotation object |
duke@1 | 130 | * returned by core reflection. This method is intended for |
duke@1 | 131 | * callers that are written to operate on a known, fixed set of |
duke@1 | 132 | * annotation types. |
duke@1 | 133 | * </blockquote> |
duke@1 | 134 | * |
duke@1 | 135 | * @param <A> the annotation type |
duke@1 | 136 | * @param annotationType the {@code Class} object corresponding to |
duke@1 | 137 | * the annotation type |
duke@1 | 138 | * @return this element's annotation for the specified annotation |
duke@1 | 139 | * type if present on this element, else {@code null} |
duke@1 | 140 | * |
duke@1 | 141 | * @see #getAnnotationMirrors() |
duke@1 | 142 | * @see java.lang.reflect.AnnotatedElement#getAnnotation |
duke@1 | 143 | * @see EnumConstantNotPresentException |
duke@1 | 144 | * @see AnnotationTypeMismatchException |
duke@1 | 145 | * @see IncompleteAnnotationException |
duke@1 | 146 | * @see MirroredTypeException |
duke@1 | 147 | * @see MirroredTypesException |
duke@1 | 148 | */ |
duke@1 | 149 | <A extends Annotation> A getAnnotation(Class<A> annotationType); |
duke@1 | 150 | |
duke@1 | 151 | /** |
jfranck@1491 | 152 | * Returns an array of all of this element's annotation for the |
jfranck@1491 | 153 | * specified type if such annotations are present, else an empty |
jfranck@1491 | 154 | * array. The annotation may be either inherited or directly |
jfranck@1491 | 155 | * present on this element. This method will look through a container |
jfranck@1491 | 156 | * annotation (if present) if the supplied annotation type is |
jfranck@1491 | 157 | * repeatable. |
jfranck@1491 | 158 | * |
jfranck@1491 | 159 | * <p> The annotations returned by this method could contain an element |
jfranck@1491 | 160 | * whose value is of type {@code Class}. |
jfranck@1491 | 161 | * This value cannot be returned directly: information necessary to |
jfranck@1491 | 162 | * locate and load a class (such as the class loader to use) is |
jfranck@1491 | 163 | * not available, and the class might not be loadable at all. |
jfranck@1491 | 164 | * Attempting to read a {@code Class} object by invoking the relevant |
jfranck@1491 | 165 | * method on the returned annotation |
jfranck@1491 | 166 | * will result in a {@link MirroredTypeException}, |
jfranck@1491 | 167 | * from which the corresponding {@link TypeMirror} may be extracted. |
jfranck@1491 | 168 | * Similarly, attempting to read a {@code Class[]}-valued element |
jfranck@1491 | 169 | * will result in a {@link MirroredTypesException}. |
jfranck@1491 | 170 | * |
jfranck@1491 | 171 | * <blockquote> |
jfranck@1491 | 172 | * <i>Note:</i> This method is unlike others in this and related |
jfranck@1491 | 173 | * interfaces. It operates on runtime reflective information — |
jfranck@1491 | 174 | * representations of annotation types currently loaded into the |
jfranck@1491 | 175 | * VM — rather than on the representations defined by and used |
jfranck@1491 | 176 | * throughout these interfaces. Consequently, calling methods on |
jfranck@1491 | 177 | * the returned annotation object can throw many of the exceptions |
jfranck@1491 | 178 | * that can be thrown when calling methods on an annotation object |
jfranck@1491 | 179 | * returned by core reflection. This method is intended for |
jfranck@1491 | 180 | * callers that are written to operate on a known, fixed set of |
jfranck@1491 | 181 | * annotation types. |
jfranck@1491 | 182 | * </blockquote> |
jfranck@1491 | 183 | * |
jfranck@1491 | 184 | * @param <A> the annotation type |
jfranck@1491 | 185 | * @param annotationType the {@code Class} object corresponding to |
jfranck@1491 | 186 | * the annotation type |
jfranck@1491 | 187 | * @return this element's annotations for the specified annotation |
jfranck@1491 | 188 | * type if present on this element, else an empty array |
jfranck@1491 | 189 | * |
jfranck@1491 | 190 | * @see #getAnnotationMirrors() |
jfranck@1491 | 191 | * @see #getAnnotation() |
jfranck@1491 | 192 | * @see java.lang.reflect.AnnotatedElement#getAnnotations |
jfranck@1491 | 193 | * @see EnumConstantNotPresentException |
jfranck@1491 | 194 | * @see AnnotationTypeMismatchException |
jfranck@1491 | 195 | * @see IncompleteAnnotationException |
jfranck@1491 | 196 | * @see MirroredTypeException |
jfranck@1491 | 197 | * @see MirroredTypesException |
jfranck@1491 | 198 | */ |
jfranck@1491 | 199 | <A extends Annotation> A[] getAnnotations(Class<A> annotationType); |
jfranck@1491 | 200 | |
jfranck@1491 | 201 | /** |
duke@1 | 202 | * Returns the modifiers of this element, excluding annotations. |
duke@1 | 203 | * Implicit modifiers, such as the {@code public} and {@code static} |
duke@1 | 204 | * modifiers of interface members, are included. |
duke@1 | 205 | * |
duke@1 | 206 | * @return the modifiers of this element, or an empty set if there are none |
duke@1 | 207 | */ |
duke@1 | 208 | Set<Modifier> getModifiers(); |
duke@1 | 209 | |
duke@1 | 210 | /** |
darcy@849 | 211 | * Returns the simple (unqualified) name of this element. The |
darcy@849 | 212 | * name of a generic type does not include any reference to its |
darcy@849 | 213 | * formal type parameters. |
darcy@849 | 214 | * |
darcy@849 | 215 | * For example, the simple name of the type element {@code |
darcy@849 | 216 | * java.util.Set<E>} is {@code "Set"}. |
darcy@849 | 217 | * |
darcy@849 | 218 | * If this element represents an unnamed {@linkplain |
darcy@849 | 219 | * PackageElement#getSimpleName package}, an empty name is |
duke@1 | 220 | * returned. |
duke@1 | 221 | * |
darcy@849 | 222 | * If it represents a {@linkplain ExecutableElement#getSimpleName |
darcy@849 | 223 | * constructor}, the name "{@code <init>}" is returned. If it |
darcy@849 | 224 | * represents a {@linkplain ExecutableElement#getSimpleName static |
darcy@849 | 225 | * initializer}, the name "{@code <clinit>}" is returned. |
darcy@849 | 226 | * |
darcy@849 | 227 | * If it represents an {@linkplain TypeElement#getSimpleName |
darcy@849 | 228 | * anonymous class} or {@linkplain ExecutableElement#getSimpleName |
darcy@849 | 229 | * instance initializer}, an empty name is returned. |
darcy@849 | 230 | * |
duke@1 | 231 | * @return the simple name of this element |
darcy@1484 | 232 | * @see PackageElement#getSimpleName |
darcy@1484 | 233 | * @see ExecutableElement#getSimpleName |
darcy@1484 | 234 | * @see TypeElement#getSimpleName |
darcy@1484 | 235 | * @see VariableElement#getSimpleName |
duke@1 | 236 | */ |
duke@1 | 237 | Name getSimpleName(); |
duke@1 | 238 | |
duke@1 | 239 | /** |
duke@1 | 240 | * Returns the innermost element |
duke@1 | 241 | * within which this element is, loosely speaking, enclosed. |
duke@1 | 242 | * <ul> |
duke@1 | 243 | * <li> If this element is one whose declaration is lexically enclosed |
duke@1 | 244 | * immediately within the declaration of another element, that other |
duke@1 | 245 | * element is returned. |
darcy@849 | 246 | * |
darcy@849 | 247 | * <li> If this is a {@linkplain TypeElement#getEnclosingElement |
darcy@849 | 248 | * top-level type}, its package is returned. |
darcy@849 | 249 | * |
darcy@849 | 250 | * <li> If this is a {@linkplain |
darcy@849 | 251 | * PackageElement#getEnclosingElement package}, {@code null} is |
darcy@849 | 252 | * returned. |
darcy@926 | 253 | * |
darcy@849 | 254 | * <li> If this is a {@linkplain |
darcy@849 | 255 | * TypeParameterElement#getEnclosingElement type parameter}, |
darcy@926 | 256 | * {@linkplain TypeParameterElement#getGenericElement the |
darcy@926 | 257 | * generic element} of the type parameter is returned. |
darcy@926 | 258 | * |
darcy@1484 | 259 | * <li> If this is a {@linkplain |
darcy@1484 | 260 | * VariableElement#getEnclosingElement method or constructor |
darcy@1484 | 261 | * parameter}, {@linkplain ExecutableElement the executable |
darcy@1484 | 262 | * element} which declares the parameter is returned. |
darcy@1484 | 263 | * |
duke@1 | 264 | * </ul> |
duke@1 | 265 | * |
duke@1 | 266 | * @return the enclosing element, or {@code null} if there is none |
duke@1 | 267 | * @see Elements#getPackageOf |
duke@1 | 268 | */ |
duke@1 | 269 | Element getEnclosingElement(); |
duke@1 | 270 | |
duke@1 | 271 | /** |
duke@1 | 272 | * Returns the elements that are, loosely speaking, directly |
duke@1 | 273 | * enclosed by this element. |
duke@1 | 274 | * |
darcy@1181 | 275 | * A {@linkplain TypeElement#getEnclosedElements class or |
darcy@1181 | 276 | * interface} is considered to enclose the fields, methods, |
darcy@1181 | 277 | * constructors, and member types that it directly declares. |
duke@1 | 278 | * |
darcy@1181 | 279 | * A {@linkplain PackageElement#getEnclosedElements package} |
darcy@1181 | 280 | * encloses the top-level classes and interfaces within it, but is |
darcy@1181 | 281 | * not considered to enclose subpackages. |
duke@1 | 282 | * |
duke@1 | 283 | * Other kinds of elements are not currently considered to enclose |
duke@1 | 284 | * any elements; however, that may change as this API or the |
duke@1 | 285 | * programming language evolves. |
duke@1 | 286 | * |
duke@1 | 287 | * <p>Note that elements of certain kinds can be isolated using |
duke@1 | 288 | * methods in {@link ElementFilter}. |
duke@1 | 289 | * |
duke@1 | 290 | * @return the enclosed elements, or an empty list if none |
darcy@1181 | 291 | * @see PackageElement#getEnclosedElements |
darcy@1181 | 292 | * @see TypeElement#getEnclosedElements |
duke@1 | 293 | * @see Elements#getAllMembers |
jjh@972 | 294 | * @jls 8.8.9 Default Constructor |
jjh@972 | 295 | * @jls 8.9 Enums |
duke@1 | 296 | */ |
duke@1 | 297 | List<? extends Element> getEnclosedElements(); |
duke@1 | 298 | |
duke@1 | 299 | /** |
duke@1 | 300 | * Returns {@code true} if the argument represents the same |
duke@1 | 301 | * element as {@code this}, or {@code false} otherwise. |
duke@1 | 302 | * |
duke@1 | 303 | * <p>Note that the identity of an element involves implicit state |
duke@1 | 304 | * not directly accessible from the element's methods, including |
duke@1 | 305 | * state about the presence of unrelated types. Element objects |
duke@1 | 306 | * created by different implementations of these interfaces should |
duke@1 | 307 | * <i>not</i> be expected to be equal even if "the same" |
duke@1 | 308 | * element is being modeled; this is analogous to the inequality |
duke@1 | 309 | * of {@code Class} objects for the same class file loaded through |
duke@1 | 310 | * different class loaders. |
duke@1 | 311 | * |
duke@1 | 312 | * @param obj the object to be compared with this element |
duke@1 | 313 | * @return {@code true} if the specified object represents the same |
duke@1 | 314 | * element as this |
duke@1 | 315 | */ |
duke@1 | 316 | boolean equals(Object obj); |
duke@1 | 317 | |
duke@1 | 318 | /** |
duke@1 | 319 | * Obeys the general contract of {@link Object#hashCode Object.hashCode}. |
duke@1 | 320 | * |
duke@1 | 321 | * @see #equals |
duke@1 | 322 | */ |
duke@1 | 323 | int hashCode(); |
duke@1 | 324 | |
duke@1 | 325 | /** |
duke@1 | 326 | * Applies a visitor to this element. |
duke@1 | 327 | * |
duke@1 | 328 | * @param <R> the return type of the visitor's methods |
duke@1 | 329 | * @param <P> the type of the additional parameter to the visitor's methods |
duke@1 | 330 | * @param v the visitor operating on this element |
duke@1 | 331 | * @param p additional parameter to the visitor |
duke@1 | 332 | * @return a visitor-specified result |
duke@1 | 333 | */ |
duke@1 | 334 | <R, P> R accept(ElementVisitor<R, P> v, P p); |
duke@1 | 335 | } |