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

Print this page




  33 /**
  34  * An annotation processor, used to examine and process the
  35  * annotations of program elements.  An annotation processor may,
  36  * for example, create new source files and XML documents to be used
  37  * in conjunction with the original code.
  38  *
  39  * <p> An annotation processor is constructed by a
  40  * {@linkplain AnnotationProcessorFactory factory}, which provides it with an
  41  * {@linkplain AnnotationProcessorEnvironment environment} that
  42  * encapsulates the state it needs.
  43  * Messages regarding warnings and errors encountered during processing
  44  * should be directed to the environment's {@link Messager},
  45  * and new files may be created using the environment's {@link Filer}.
  46  *
  47  * <p> Each annotation processor is created to process annotations
  48  * of a particular annotation type or set of annotation types.
  49  * It may use its environment to find the program elements with
  50  * annotations of those types.  It may freely examine any other program
  51  * elements in the course of its processing.
  52  *





  53  * @author Joseph D. Darcy
  54  * @author Scott Seligman
  55  * @since 1.5
  56  */
  57 

  58 public interface AnnotationProcessor {
  59 
  60     /**
  61      * Process all program elements supported by this annotation processor.
  62      */
  63     void process();
  64 }


  33 /**
  34  * An annotation processor, used to examine and process the
  35  * annotations of program elements.  An annotation processor may,
  36  * for example, create new source files and XML documents to be used
  37  * in conjunction with the original code.
  38  *
  39  * <p> An annotation processor is constructed by a
  40  * {@linkplain AnnotationProcessorFactory factory}, which provides it with an
  41  * {@linkplain AnnotationProcessorEnvironment environment} that
  42  * encapsulates the state it needs.
  43  * Messages regarding warnings and errors encountered during processing
  44  * should be directed to the environment's {@link Messager},
  45  * and new files may be created using the environment's {@link Filer}.
  46  *
  47  * <p> Each annotation processor is created to process annotations
  48  * of a particular annotation type or set of annotation types.
  49  * It may use its environment to find the program elements with
  50  * annotations of those types.  It may freely examine any other program
  51  * elements in the course of its processing.
  52  *
  53  * @deprecated All components of this API have been superseded by the
  54  * standardized annotation processing API.  The replacement for the
  55  * functionality of this interface is {@link
  56  * javax.annotation.processing.Processor}.
  57  *
  58  * @author Joseph D. Darcy
  59  * @author Scott Seligman
  60  * @since 1.5
  61  */
  62 @Deprecated
  63 @SuppressWarnings("deprecation")
  64 public interface AnnotationProcessor {
  65 
  66     /**
  67      * Process all program elements supported by this annotation processor.
  68      */
  69     void process();
  70 }