Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/javax/annotation/processing/RoundEnvironment.java@2eb010b6cb22 (annotated)
src/share/classes/javax/annotation/processing/RoundEnvironment.java
Thu, 31 Aug 2017 15:17:03 +0800
- author
- aoqi
- date
- Thu, 31 Aug 2017 15:17:03 +0800
- changeset 2525
- 2eb010b6cb22
- parent 554
- 9d9f26857129
- parent 0
- 959103a6100f
- permissions
- -rw-r--r--
merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2005, 2007, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package javax.annotation.processing; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import javax.lang.model.element.Element; |
| aoqi@0 | 29 | import javax.lang.model.element.TypeElement; |
| aoqi@0 | 30 | import java.util.Set; |
| aoqi@0 | 31 | import java.lang.annotation.Annotation; |
| aoqi@0 | 32 | |
| aoqi@0 | 33 | /** |
| aoqi@0 | 34 | * An annotation processing tool framework will {@linkplain |
| aoqi@0 | 35 | * Processor#process provide an annotation processor with an object |
| aoqi@0 | 36 | * implementing this interface} so that the processor can query for |
| aoqi@0 | 37 | * information about a round of annotation processing. |
| aoqi@0 | 38 | * |
| aoqi@0 | 39 | * @author Joseph D. Darcy |
| aoqi@0 | 40 | * @author Scott Seligman |
| aoqi@0 | 41 | * @author Peter von der Ahé |
| aoqi@0 | 42 | * @since 1.6 |
| aoqi@0 | 43 | */ |
| aoqi@0 | 44 | public interface RoundEnvironment { |
| aoqi@0 | 45 | /** |
| aoqi@0 | 46 | * Returns {@code true} if types generated by this round will not |
| aoqi@0 | 47 | * be subject to a subsequent round of annotation processing; |
| aoqi@0 | 48 | * returns {@code false} otherwise. |
| aoqi@0 | 49 | * |
| aoqi@0 | 50 | * @return {@code true} if types generated by this round will not |
| aoqi@0 | 51 | * be subject to a subsequent round of annotation processing; |
| aoqi@0 | 52 | * returns {@code false} otherwise |
| aoqi@0 | 53 | */ |
| aoqi@0 | 54 | boolean processingOver(); |
| aoqi@0 | 55 | |
| aoqi@0 | 56 | /** |
| aoqi@0 | 57 | * Returns {@code true} if an error was raised in the prior round |
| aoqi@0 | 58 | * of processing; returns {@code false} otherwise. |
| aoqi@0 | 59 | * |
| aoqi@0 | 60 | * @return {@code true} if an error was raised in the prior round |
| aoqi@0 | 61 | * of processing; returns {@code false} otherwise |
| aoqi@0 | 62 | */ |
| aoqi@0 | 63 | boolean errorRaised(); |
| aoqi@0 | 64 | |
| aoqi@0 | 65 | /** |
| aoqi@0 | 66 | * Returns the root elements for annotation processing generated |
| aoqi@0 | 67 | * by the prior round. |
| aoqi@0 | 68 | * |
| aoqi@0 | 69 | * @return the root elements for annotation processing generated |
| aoqi@0 | 70 | * by the prior round, or an empty set if there were none |
| aoqi@0 | 71 | */ |
| aoqi@0 | 72 | Set<? extends Element> getRootElements(); |
| aoqi@0 | 73 | |
| aoqi@0 | 74 | /** |
| aoqi@0 | 75 | * Returns the elements annotated with the given annotation type. |
| aoqi@0 | 76 | * The annotation may appear directly or be inherited. Only |
| aoqi@0 | 77 | * package elements and type elements <i>included</i> in this |
| aoqi@0 | 78 | * round of annotation processing, or declarations of members, |
| aoqi@0 | 79 | * constructors, parameters, or type parameters declared within |
| aoqi@0 | 80 | * those, are returned. Included type elements are {@linkplain |
| aoqi@0 | 81 | * #getRootElements root types} and any member types nested within |
| aoqi@0 | 82 | * them. Elements in a package are not considered included simply |
| aoqi@0 | 83 | * because a {@code package-info} file for that package was |
| aoqi@0 | 84 | * created. |
| aoqi@0 | 85 | * |
| aoqi@0 | 86 | * @param a annotation type being requested |
| aoqi@0 | 87 | * @return the elements annotated with the given annotation type, |
| aoqi@0 | 88 | * or an empty set if there are none |
| aoqi@0 | 89 | * @throws IllegalArgumentException if the argument does not |
| aoqi@0 | 90 | * represent an annotation type |
| aoqi@0 | 91 | */ |
| aoqi@0 | 92 | Set<? extends Element> getElementsAnnotatedWith(TypeElement a); |
| aoqi@0 | 93 | |
| aoqi@0 | 94 | /** |
| aoqi@0 | 95 | * Returns the elements annotated with the given annotation type. |
| aoqi@0 | 96 | * The annotation may appear directly or be inherited. Only |
| aoqi@0 | 97 | * package elements and type elements <i>included</i> in this |
| aoqi@0 | 98 | * round of annotation processing, or declarations of members, |
| aoqi@0 | 99 | * constructors, parameters, or type parameters declared within |
| aoqi@0 | 100 | * those, are returned. Included type elements are {@linkplain |
| aoqi@0 | 101 | * #getRootElements root types} and any member types nested within |
| aoqi@0 | 102 | * them. Elements in a package are not considered included simply |
| aoqi@0 | 103 | * because a {@code package-info} file for that package was |
| aoqi@0 | 104 | * created. |
| aoqi@0 | 105 | * |
| aoqi@0 | 106 | * @param a annotation type being requested |
| aoqi@0 | 107 | * @return the elements annotated with the given annotation type, |
| aoqi@0 | 108 | * or an empty set if there are none |
| aoqi@0 | 109 | * @throws IllegalArgumentException if the argument does not |
| aoqi@0 | 110 | * represent an annotation type |
| aoqi@0 | 111 | */ |
| aoqi@0 | 112 | Set<? extends Element> getElementsAnnotatedWith(Class<? extends Annotation> a); |
| aoqi@0 | 113 | } |
