/*
* @(#)AnnotationProcessor.java 1.2 04/02/10
*
* Copyright (c) 2004, Sun Microsystems, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the Sun Microsystems, Inc. nor the names of
* its contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.sun.mirror.apt;
/**
* An annotation processor, used to examine and process the
* annotations of program elements. An annotation processor may,
* for example, create new source files and XML documents to be used
* in conjunction with the original code.
*
* <p> An annotation processor is constructed by a
* {@linkplain AnnotationProcessorFactory factory}, which provides it with an
* {@linkplain AnnotationProcessorEnvironment environment} that
* encapsulates the state it needs.
* Messages regarding warnings and errors encountered during processing
* should be directed to the environment's {@link Messager},
* and new files may be created using the environment's {@link Filer}.
*
* <p> Each annotation processor is created to process annotations
* of a particular annotation type or set of annotation types.
* It may use its environment to find the program elements with
* annotations of those types. It may freely examine any other program
* elements in the course of its processing.
*
* @author Joseph D. Darcy
* @author Scott Seligman
* @version 1.2 04/02/10
* @since 1.5
*/
public interface AnnotationProcessor {
/**
* Process all program elements supported by this annotation processor.
*/
void process();
}