- /*
- * @(#)AnnotationProcessorFactory.java 1.9 04/07/13
- *
- * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
- * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
- */
-
- package com.sun.mirror.apt;
-
-
- import java.util.Collection;
- import java.util.Set;
-
- import com.sun.mirror.declaration.AnnotationTypeDeclaration;
-
-
- /**
- * A factory for creating annotation processors.
- * Each factory is responsible for creating processors for one or more
- * annotation types.
- * The factory is said to <i>support</i> these types.
- *
- * <p> Each implementation of an <tt>AnnotationProcessorFactory</tt>
- * must provide a public no-argument constructor to be used by tools to
- * instantiate the factory.
- *
- * @author Joseph D. Darcy
- * @author Scott Seligman
- * @version 1.9 04/07/13
- * @since 1.5
- */
-
- public interface AnnotationProcessorFactory {
-
- /**
- * Returns the options recognized by this factory or by any of the
- * processors it may create.
- * Only {@linkplain AnnotationProcessorEnvironment#getOptions()
- * processor-specific} options are included, each of which begins
- * with <tt>"-A"</tt>. For example, if this factory recognizes
- * options such as <tt>-Adebug -Aloglevel=3</tt>, it will
- * return the strings <tt>"-Adebug"</tt> and <tt>"-Aloglevel"</tt>.
- *
- * <p> A tool might use this information to determine if any
- * options provided by a user are unrecognized by any processor,
- * in which case it may wish to report an error.
- *
- * @return the options recognized by this factory or by any of the
- * processors it may create, or an empty collection if none
- */
- Collection<String> supportedOptions();
-
- /**
- * Returns the names of the annotation types supported by this factory.
- * An element of the result may be the canonical (fully qualified) name
- * of a supported annotation type. Alternately it may be of the form
- * <tt>"<i>name</i>.*"</tt>
- * representing the set of all annotation types
- * with canonical names beginning with <tt>"<i>name</i>."</tt>
- * Finally, <tt>"*"</tt> by itself represents the set of all
- * annotation types.
- *
- * @return the names of the annotation types supported by this factory
- */
- Collection<String> supportedAnnotationTypes();
-
- /**
- * Returns an annotation processor for a set of annotation
- * types. The set will be empty if the factory supports
- * "<tt>*</tt>" and the specified type declarations have
- * no annotations. Note that the set of annotation types may be
- * empty for other reasons, such as giving the factory an
- * opportunity to register a listener. An
- * <tt>AnnotationProcessorFactory</tt> must gracefully handle an
- * empty set of annotations; an appropriate response to an empty
- * set will often be returning {@link AnnotationProcessors#NO_OP}.
- *
- * @param atds type declarations of the annotation types to be processed
- * @param env environment to use during processing
- * @return an annotation processor for the given annotation types,
- * or <tt>null</tt> if the types are not supported or the
- * processor cannot be created
- */
- AnnotationProcessor getProcessorFor(Set<AnnotationTypeDeclaration> atds,
- AnnotationProcessorEnvironment env);
- }