Sat, 01 Dec 2007 00:00:00 +0000
Initial load
1 /*
2 * Copyright 2005-2006 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
26 package javax.annotation.processing;
28 import java.util.Map;
29 import java.util.List;
30 import java.util.Locale;
31 import javax.lang.model.SourceVersion;
32 import javax.lang.model.util.Elements;
33 import javax.lang.model.util.Types;
34 import java.io.File;
36 /**
37 * An annotation processing tool framework will {@linkplain
38 * Processor#init provide an annotation processor with an object
39 * implementing this interface} so the processor can use facilities
40 * provided by the framework to write new files, report error
41 * messages, and find other utilities.
42 *
43 * <p>Third parties may wish to provide value-add wrappers around the
44 * facility objects from this interface, for example a {@code Filer}
45 * extension that allows multiple processors to coordinate writing out
46 * a single source file. To enable this, for processors running in a
47 * context where their side effects via the API could be visible to
48 * each other, the tool infrastructure must provide corresponding
49 * facility objects that are {@code .equals}, {@code Filer}s that are
50 * {@code .equals}, and so on. In addition, the tool invocation must
51 * be able to be configured such that from the perspective of the
52 * running annotation processors, at least the chosen subset of helper
53 * classes are viewed as being loaded by the same class loader.
54 * (Since the facility objects manage shared state, the implementation
55 * of a wrapper class must know whether or not the same base facility
56 * object has been wrapped before.)
57 *
58 * @author Joseph D. Darcy
59 * @author Scott Seligman
60 * @author Peter von der Ahé
61 * @since 1.6
62 */
63 public interface ProcessingEnvironment {
64 /**
65 * Returns the processor-specific options passed to the annotation
66 * processing tool. Options are returned in the form of a map from
67 * option name to option value. For an option with no value, the
68 * corresponding value in the map is {@code null}.
69 *
70 * <p>See documentation of the particular tool infrastructure
71 * being used for details on how to pass in processor-specific
72 * options. For example, a command-line implementation may
73 * distinguish processor-specific options by prefixing them with a
74 * known string like {@code "-A"}; other tool implementations may
75 * follow different conventions or provide alternative mechanisms.
76 * A given implementation may also provide implementation-specific
77 * ways of finding options passed to the tool in addition to the
78 * processor-specific options.
79 *
80 * @return the processor-specific options passed to the tool
81 */
82 Map<String,String> getOptions();
84 /**
85 * Returns the messager used to report errors, warnings, and other
86 * notices.
87 *
88 * @return the messager
89 */
90 Messager getMessager();
92 /**
93 * Returns the filer used to create new source, class, or auxiliary
94 * files.
95 *
96 * @return the filer
97 */
98 Filer getFiler();
100 /**
101 * Returns an implementation of some utility methods for
102 * operating on elements
103 *
104 * @return element utilities
105 */
106 Elements getElementUtils();
108 /**
109 * Returns an implementation of some utility methods for
110 * operating on types.
111 *
112 * @return type utilities
113 */
114 Types getTypeUtils();
116 /**
117 * Returns the source version that any generated {@linkplain
118 * Filer#createSourceFile source} and {@linkplain
119 * Filer#createClassFile class} files should conform to.
120 *
121 * @return the source version to which generated source and class
122 * files should conform to
123 * @see Processor#getSupportedSourceVersion
124 */
125 SourceVersion getSourceVersion();
127 /**
128 * Returns the current locale or {@code null} if no locale is in
129 * effect. The locale can be be used to provide localized
130 * {@linkplain Messager messages}.
131 *
132 * @return the current locale or {@code null} if no locale is in
133 * effect
134 */
135 Locale getLocale();
136 }