aoqi@0: /*
aoqi@0:  * Copyright (c) 2005, 2007, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package javax.annotation.processing;
aoqi@0: 
aoqi@0: import javax.lang.model.element.Element;
aoqi@0: import javax.lang.model.element.TypeElement;
aoqi@0: import java.util.Set;
aoqi@0: import java.lang.annotation.Annotation;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * An annotation processing tool framework will {@linkplain
aoqi@0:  * Processor#process provide an annotation processor with an object
aoqi@0:  * implementing this interface} so that the processor can query for
aoqi@0:  * information about a round of annotation processing.
aoqi@0:  *
aoqi@0:  * @author Joseph D. Darcy
aoqi@0:  * @author Scott Seligman
aoqi@0:  * @author Peter von der Ahé
aoqi@0:  * @since 1.6
aoqi@0:  */
aoqi@0: public interface RoundEnvironment {
aoqi@0:     /**
aoqi@0:      * Returns {@code true} if types generated by this round will not
aoqi@0:      * be subject to a subsequent round of annotation processing;
aoqi@0:      * returns {@code false} otherwise.
aoqi@0:      *
aoqi@0:      * @return {@code true} if types generated by this round will not
aoqi@0:      * be subject to a subsequent round of annotation processing;
aoqi@0:      * returns {@code false} otherwise
aoqi@0:      */
aoqi@0:     boolean processingOver();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns {@code true} if an error was raised in the prior round
aoqi@0:      * of processing; returns {@code false} otherwise.
aoqi@0:      *
aoqi@0:      * @return {@code true} if an error was raised in the prior round
aoqi@0:      * of processing; returns {@code false} otherwise
aoqi@0:      */
aoqi@0:     boolean errorRaised();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns the root elements for annotation processing generated
aoqi@0:      * by the prior round.
aoqi@0:      *
aoqi@0:      * @return the root elements for annotation processing generated
aoqi@0:      * by the prior round, or an empty set if there were none
aoqi@0:      */
aoqi@0:     Set<? extends Element> getRootElements();
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns the elements annotated with the given annotation type.
aoqi@0:      * The annotation may appear directly or be inherited.  Only
aoqi@0:      * package elements and type elements <i>included</i> in this
aoqi@0:      * round of annotation processing, or declarations of members,
aoqi@0:      * constructors, parameters, or type parameters declared within
aoqi@0:      * those, are returned.  Included type elements are {@linkplain
aoqi@0:      * #getRootElements root types} and any member types nested within
aoqi@0:      * them.  Elements in a package are not considered included simply
aoqi@0:      * because a {@code package-info} file for that package was
aoqi@0:      * created.
aoqi@0:      *
aoqi@0:      * @param a  annotation type being requested
aoqi@0:      * @return the elements annotated with the given annotation type,
aoqi@0:      * or an empty set if there are none
aoqi@0:      * @throws IllegalArgumentException if the argument does not
aoqi@0:      * represent an annotation type
aoqi@0:      */
aoqi@0:     Set<? extends Element> getElementsAnnotatedWith(TypeElement a);
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Returns the elements annotated with the given annotation type.
aoqi@0:      * The annotation may appear directly or be inherited.  Only
aoqi@0:      * package elements and type elements <i>included</i> in this
aoqi@0:      * round of annotation processing, or declarations of members,
aoqi@0:      * constructors, parameters, or type parameters declared within
aoqi@0:      * those, are returned.  Included type elements are {@linkplain
aoqi@0:      * #getRootElements root types} and any member types nested within
aoqi@0:      * them.  Elements in a package are not considered included simply
aoqi@0:      * because a {@code package-info} file for that package was
aoqi@0:      * created.
aoqi@0:      *
aoqi@0:      * @param a  annotation type being requested
aoqi@0:      * @return the elements annotated with the given annotation type,
aoqi@0:      * or an empty set if there are none
aoqi@0:      * @throws IllegalArgumentException if the argument does not
aoqi@0:      * represent an annotation type
aoqi@0:      */
aoqi@0:     Set<? extends Element> getElementsAnnotatedWith(Class<? extends Annotation> a);
aoqi@0: }