001 /*
002 * Copyright 2004 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 com.sun.mirror.apt;
027
028
029 import java.util.Collection;
030 import java.util.Set;
031
032 import com.sun.mirror.declaration.AnnotationTypeDeclaration;
033
034
035 /**
036 * A factory for creating annotation processors.
037 * Each factory is responsible for creating processors for one or more
038 * annotation types.
039 * The factory is said to <i>support</i> these types.
040 *
041 * <p> Each implementation of an <tt>AnnotationProcessorFactory</tt>
042 * must provide a public no-argument constructor to be used by tools to
043 * instantiate the factory.
044 *
045 * @author Joseph D. Darcy
046 * @author Scott Seligman
047 * @since 1.5
048 */
049
050 public interface AnnotationProcessorFactory {
051
052 /**
053 * Returns the options recognized by this factory or by any of the
054 * processors it may create.
055 * Only {@linkplain AnnotationProcessorEnvironment#getOptions()
056 * processor-specific} options are included, each of which begins
057 * with <tt>"-A"</tt>. For example, if this factory recognizes
058 * options such as <tt>-Adebug -Aloglevel=3</tt>, it will
059 * return the strings <tt>"-Adebug"</tt> and <tt>"-Aloglevel"</tt>.
060 *
061 * <p> A tool might use this information to determine if any
062 * options provided by a user are unrecognized by any processor,
063 * in which case it may wish to report an error.
064 *
065 * @return the options recognized by this factory or by any of the
066 * processors it may create, or an empty collection if none
067 */
068 Collection<String> supportedOptions();
069
070 /**
071 * Returns the names of the annotation types supported by this factory.
072 * An element of the result may be the canonical (fully qualified) name
073 * of a supported annotation type. Alternately it may be of the form
074 * <tt>"<i>name</i>.*"</tt>
075 * representing the set of all annotation types
076 * with canonical names beginning with <tt>"<i>name</i>."</tt>
077 * Finally, <tt>"*"</tt> by itself represents the set of all
078 * annotation types.
079 *
080 * @return the names of the annotation types supported by this factory
081 */
082 Collection<String> supportedAnnotationTypes();
083
084 /**
085 * Returns an annotation processor for a set of annotation
086 * types. The set will be empty if the factory supports
087 * "<tt>*</tt>" and the specified type declarations have
088 * no annotations. Note that the set of annotation types may be
089 * empty for other reasons, such as giving the factory an
090 * opportunity to register a listener. An
091 * <tt>AnnotationProcessorFactory</tt> must gracefully handle an
092 * empty set of annotations; an appropriate response to an empty
093 * set will often be returning {@link AnnotationProcessors#NO_OP}.
094 *
095 * @param atds type declarations of the annotation types to be processed
096 * @param env environment to use during processing
097 * @return an annotation processor for the given annotation types,
098 * or <tt>null</tt> if the types are not supported or the
099 * processor cannot be created
100 */
101 AnnotationProcessor getProcessorFor(Set<AnnotationTypeDeclaration> atds,
102 AnnotationProcessorEnvironment env);
103 }