Package com.sun.tools.javac.processing

Class JavacProcessingEnvironment

java.lang.Object

com.sun.tools.javac.processing.JavacProcessingEnvironment

All Implemented Interfaces:

Closeable, AutoCloseable, ProcessingEnvironment

public class JavacProcessingEnvironment
extends Object
implements ProcessingEnvironment, Closeable

Objects of this class hold and manage the state needed to support annotation processing.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavacProcessingEnvironment.ComputeAnnotationSet Computes the set of annotations on the symbol in question.

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	noMatches

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JavacProcessingEnvironment(Context context)

Method Summary

Modifier and Type	Method and Description
boolean	atLeastOneProcessor()
void	close() Free resources related to annotation processing.
JavaCompiler	doProcessing(Context context, List<JCTree.JCCompilationUnit> roots, List<Symbol.ClassSymbol> classSymbols, Iterable<? extends Symbol.PackageSymbol> pckSymbols, Log.DeferredDiagnosticHandler deferredDiagnosticHandler)
Context	getContext() For internal use only.
JavacElements	getElementUtils()
Filer	getFiler()
Locale	getLocale()
Messager	getMessager()
Map<String,String>	getOptions() Command line options suitable for presenting to annotation processors.
ClassLoader	getProcessorClassLoader() For internal use only.
SourceVersion	getSourceVersion()
Set<Symbol.PackageSymbol>	getSpecifiedPackages()
JavacTypes	getTypeUtils()
static JavacProcessingEnvironment	instance(Context context) Get the JavacProcessingEnvironment instance for this context.
static boolean	isValidImportString(String s) Return true if the argument string is a valid import-style string specifying claimed annotations; return false otherwise.
static boolean	isValidOptionName(String optionName)
void	setProcessors(Iterable<? extends Processor> processors)
String	toString()
static Pattern	validImportStringToPattern(String s)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

noMatches

public static final Pattern noMatches

Constructor Detail

JavacProcessingEnvironment

protected JavacProcessingEnvironment(Context context)

Method Detail

instance

public static JavacProcessingEnvironment instance(Context context)

Get the JavacProcessingEnvironment instance for this context.

setProcessors

public void setProcessors(Iterable<? extends Processor> processors)

atLeastOneProcessor

public boolean atLeastOneProcessor()

doProcessing

public JavaCompiler doProcessing(Context context,
                                 List<JCTree.JCCompilationUnit> roots,
                                 List<Symbol.ClassSymbol> classSymbols,
                                 Iterable<? extends Symbol.PackageSymbol> pckSymbols,
                                 Log.DeferredDiagnosticHandler deferredDiagnosticHandler)

close

public void close()

Free resources related to annotation processing.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

getOptions

public Map<String,String> getOptions()

Command line options suitable for presenting to annotation processors. "-Afoo=bar" should be "-Afoo" => "bar".

Specified by:

getOptions in interface ProcessingEnvironment

getMessager

public Messager getMessager()

Specified by:

getMessager in interface ProcessingEnvironment

getFiler

public Filer getFiler()

Specified by:

getFiler in interface ProcessingEnvironment

getElementUtils

public JavacElements getElementUtils()

Specified by:

getElementUtils in interface ProcessingEnvironment

getTypeUtils

public JavacTypes getTypeUtils()

Specified by:

getTypeUtils in interface ProcessingEnvironment

getSourceVersion

public SourceVersion getSourceVersion()

Specified by:

getSourceVersion in interface ProcessingEnvironment

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ProcessingEnvironment

getSpecifiedPackages

public Set<Symbol.PackageSymbol> getSpecifiedPackages()

isValidImportString

public static boolean isValidImportString(String s)

Return true if the argument string is a valid import-style string specifying claimed annotations; return false otherwise.

validImportStringToPattern

public static Pattern validImportStringToPattern(String s)

getContext

public Context getContext()

For internal use only. This method may be removed without warning.

getProcessorClassLoader

public ClassLoader getProcessorClassLoader()

For internal use only. This method may be removed without warning.

toString

public String toString()

Overrides:

toString in class Object

isValidOptionName

public static boolean isValidOptionName(String optionName)