src/share/classes/com/sun/mirror/apt/AnnotationProcessorFactory.java

Print this page




  25 
  26 package com.sun.mirror.apt;
  27 
  28 
  29 import java.util.Collection;
  30 import java.util.Set;
  31 
  32 import com.sun.mirror.declaration.AnnotationTypeDeclaration;
  33 
  34 
  35 /**
  36  * A factory for creating annotation processors.
  37  * Each factory is responsible for creating processors for one or more
  38  * annotation types.
  39  * The factory is said to <i>support</i> these types.
  40  *
  41  * <p> Each implementation of an <tt>AnnotationProcessorFactory</tt>
  42  * must provide a public no-argument constructor to be used by tools to
  43  * instantiate the factory.
  44  *





  45  * @author Joseph D. Darcy
  46  * @author Scott Seligman
  47  * @since 1.5
  48  */
  49 

  50 public interface AnnotationProcessorFactory {
  51 
  52     /**
  53      * Returns the options recognized by this factory or by any of the
  54      * processors it may create.
  55      * Only {@linkplain AnnotationProcessorEnvironment#getOptions()
  56      * processor-specific} options are included, each of which begins
  57      * with <tt>"-A"</tt>.  For example, if this factory recognizes
  58      * options such as <tt>-Adebug -Aloglevel=3</tt>, it will
  59      * return the strings <tt>"-Adebug"</tt> and <tt>"-Aloglevel"</tt>.
  60      *
  61      * <p> A tool might use this information to determine if any
  62      * options provided by a user are unrecognized by any processor,
  63      * in which case it may wish to report an error.
  64      *
  65      * @return the options recognized by this factory or by any of the
  66      * processors it may create, or an empty collection if none
  67      */
  68     Collection<String> supportedOptions();
  69 




  25 
  26 package com.sun.mirror.apt;
  27 
  28 
  29 import java.util.Collection;
  30 import java.util.Set;
  31 
  32 import com.sun.mirror.declaration.AnnotationTypeDeclaration;
  33 
  34 
  35 /**
  36  * A factory for creating annotation processors.
  37  * Each factory is responsible for creating processors for one or more
  38  * annotation types.
  39  * The factory is said to <i>support</i> these types.
  40  *
  41  * <p> Each implementation of an <tt>AnnotationProcessorFactory</tt>
  42  * must provide a public no-argument constructor to be used by tools to
  43  * instantiate the factory.
  44  *
  45  * @deprecated All components of this API have been superseded by the
  46  * standardized annotation processing API.  The replacement for the
  47  * functionality of this interface is {@link
  48  * javax.annotation.processing.Processor}.
  49  *
  50  * @author Joseph D. Darcy
  51  * @author Scott Seligman
  52  * @since 1.5
  53  */
  54 @Deprecated
  55 @SuppressWarnings("deprecation")
  56 public interface AnnotationProcessorFactory {
  57 
  58     /**
  59      * Returns the options recognized by this factory or by any of the
  60      * processors it may create.
  61      * Only {@linkplain AnnotationProcessorEnvironment#getOptions()
  62      * processor-specific} options are included, each of which begins
  63      * with <tt>"-A"</tt>.  For example, if this factory recognizes
  64      * options such as <tt>-Adebug -Aloglevel=3</tt>, it will
  65      * return the strings <tt>"-Adebug"</tt> and <tt>"-Aloglevel"</tt>.
  66      *
  67      * <p> A tool might use this information to determine if any
  68      * options provided by a user are unrecognized by any processor,
  69      * in which case it may wish to report an error.
  70      *
  71      * @return the options recognized by this factory or by any of the
  72      * processors it may create, or an empty collection if none
  73      */
  74     Collection<String> supportedOptions();
  75