001 /*
002 * Copyright 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.annotation.processing;
027
028 import javax.lang.model.element.Element;
029 import javax.lang.model.element.TypeElement;
030 import java.util.Set;
031 import java.lang.annotation.Annotation;
032
033 /**
034 * An annotation processing tool framework will {@linkplain
035 * Processor#process provide an annotation processor with an object
036 * implementing this interface} so that the processor can query for
037 * information about a round of annotation processing.
038 *
039 * @author Joseph D. Darcy
040 * @author Scott Seligman
041 * @author Peter von der Ahé
042 * @since 1.6
043 */
044 public interface RoundEnvironment {
045 /**
046 * Returns {@code true} if types generated by this round will not
047 * be subject to a subsequent round of annotation processing;
048 * returns {@code false} otherwise.
049 *
050 * @return {@code true} if types generated by this round will not
051 * be subject to a subsequent round of annotation processing;
052 * returns {@code false} otherwise
053 */
054 boolean processingOver();
055
056 /**
057 * Returns {@code true} if an error was raised in the prior round
058 * of processing; returns {@code false} otherwise.
059 *
060 * @return {@code true} if an error was raised in the prior round
061 * of processing; returns {@code false} otherwise
062 */
063 boolean errorRaised();
064
065 /**
066 * Returns the root elements for annotation processing generated
067 * by the prior round.
068 *
069 * @return the root elements for annotation processing generated
070 * by the prior round, or an empty set if there were none
071 */
072 Set<? extends Element> getRootElements();
073
074 /**
075 * Returns the elements annotated with the given annotation type.
076 * The annotation may appear directly or be inherited. Only
077 * package elements and type elements <i>included</i> in this
078 * round of annotation processing, or declarations of members,
079 * constructors, parameters, or type parameters declared within
080 * those, are returned. Included type elements are {@linkplain
081 * #getRootElements root types} and any member types nested within
082 * them. Elements in a package are not considered included simply
083 * because a {@code package-info} file for that package was
084 * created.
085 *
086 * @param a annotation type being requested
087 * @return the elements annotated with the given annotation type,
088 * or an empty set if there are none
089 * @throws IllegalArgumentException if the argument does not
090 * represent an annotation type
091 */
092 Set<? extends Element> getElementsAnnotatedWith(TypeElement a);
093
094 /**
095 * Returns the elements annotated with the given annotation type.
096 * The annotation may appear directly or be inherited. Only
097 * package elements and type elements <i>included</i> in this
098 * round of annotation processing, or declarations of members,
099 * constructors, parameters, or type parameters declared within
100 * those, are returned. Included type elements are {@linkplain
101 * #getRootElements root types} and any member types nested within
102 * them. Elements in a package are not considered included simply
103 * because a {@code package-info} file for that package was
104 * created.
105 *
106 * @param a annotation type being requested
107 * @return the elements annotated with the given annotation type,
108 * or an empty set if there are none
109 * @throws IllegalArgumentException if the argument does not
110 * represent an annotation type
111 */
112 Set<? extends Element> getElementsAnnotatedWith(Class<? extends Annotation> a);
113 }