01: /*
02: * @(#)AnnotationProcessor.java 1.2 04/02/10
03: *
04: * Copyright (c) 2004, Sun Microsystems, Inc.
05: * All rights reserved.
06: *
07: * Redistribution and use in source and binary forms, with or without
08: * modification, are permitted provided that the following conditions are met:
09: *
10: * * Redistributions of source code must retain the above copyright
11: * notice, this list of conditions and the following disclaimer.
12: * * Redistributions in binary form must reproduce the above copyright
13: * notice, this list of conditions and the following disclaimer in the
14: * documentation and/or other materials provided with the distribution.
15: * * Neither the name of the Sun Microsystems, Inc. nor the names of
16: * its contributors may be used to endorse or promote products derived from
17: * this software without specific prior written permission.
18: *
19: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
20: * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21: * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
22: * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
23: * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26: * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27: * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28: * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30: */
31:
32: package com.sun.mirror.apt;
33:
34: /**
35: * An annotation processor, used to examine and process the
36: * annotations of program elements. An annotation processor may,
37: * for example, create new source files and XML documents to be used
38: * in conjunction with the original code.
39: *
40: * <p> An annotation processor is constructed by a
41: * {@linkplain AnnotationProcessorFactory factory}, which provides it with an
42: * {@linkplain AnnotationProcessorEnvironment environment} that
43: * encapsulates the state it needs.
44: * Messages regarding warnings and errors encountered during processing
45: * should be directed to the environment's {@link Messager},
46: * and new files may be created using the environment's {@link Filer}.
47: *
48: * <p> Each annotation processor is created to process annotations
49: * of a particular annotation type or set of annotation types.
50: * It may use its environment to find the program elements with
51: * annotations of those types. It may freely examine any other program
52: * elements in the course of its processing.
53: *
54: * @author Joseph D. Darcy
55: * @author Scott Seligman
56: * @version 1.2 04/02/10
57: * @since 1.5
58: */
59:
60: public interface AnnotationProcessor {
61:
62: /**
63: * Process all program elements supported by this annotation processor.
64: */
65: void process();
66: }
|