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