1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
/* * @(#)ProcessingEnvironment.java 1.5 06/07/17 * * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.annotation.processing; import java.util.Map; import java.util.List; import java.util.Locale; import javax.lang.model.SourceVersion; import javax.lang.model.util.Elements; import javax.lang.model.util.Types; import java.io.File; /** * An annotation processing tool framework will {@linkplain * Processor#init provide an annotation processor with an object * implementing this interface} so the processor can use facilities * provided by the framework to write new files, report error * messages, and find other utilities. * * <p>Third parties may wish to provide value-add wrappers around the * facility objects from this interface, for example a {@code Filer} * extension that allows multiple processors to coordinate writing out * a single source file. To enable this, for processors running in a * context where their side effects via the API could be visible to * each other, the tool infrastructure must provide corresponding * facility objects that are {@code .equals}, {@code Filer}s that are * {@code .equals}, and so on. In addition, the tool invocation must * be able to be configured such that from the perspective of the * running annotation processors, at least the chosen subset of helper * classes are viewed as being loaded by the same class loader. * (Since the facility objects manage shared state, the implementation * of a wrapper class must know whether or not the same base facility * object has been wrapped before.) * * @author Joseph D. Darcy * @author Scott Seligman * @author Peter von der Ahé * @version 1.5 06/07/17 * @since 1.6 */ public interface ProcessingEnvironment { /** * Returns the processor-specific options passed to the annotation * processing tool. Options are returned in the form of a map from * option name to option value. For an option with no value, the * corresponding value in the map is {@code null}. * * <p>See documentation of the particular tool infrastructure * being used for details on how to pass in processor-specific * options. For example, a command-line implementation may * distinguish processor-specific options by prefixing them with a * known string like {@code "-A"}; other tool implementations may * follow different conventions or provide alternative mechanisms. * A given implementation may also provide implementation-specific * ways of finding options passed to the tool in addition to the * processor-specific options. * * @return the processor-specific options passed to the tool */ Map<String,String> getOptions(); /** * Returns the messager used to report errors, warnings, and other * notices. * * @return the messager */ Messager getMessager(); /** * Returns the filer used to create new source, class, or auxiliary * files. * * @return the filer */ Filer getFiler(); /** * Returns an implementation of some utility methods for * operating on elements * * @return element utilities */ Elements getElementUtils(); /** * Returns an implementation of some utility methods for * operating on types. * * @return type utilities */ Types getTypeUtils(); /** * Returns the source version that any generated {@linkplain * Filer#createSourceFile source} and {@linkplain * Filer#createClassFile class} files should conform to. * * @return the source version to which generated source and class * files should conform to * @see Processor#getSupportedSourceVersion */ SourceVersion getSourceVersion(); /** * Returns the current locale or {@code null} if no locale is in * effect. The locale can be be used to provide localized * {@linkplain Messager messages}. * * @return the current locale or {@code null} if no locale is in * effect */ Locale getLocale(); }