- java.lang.Object
-
- com.sun.source.util.JavacTask
-
- All Implemented Interfaces:
Callable<Boolean>,JavaCompiler.CompilationTask
public abstract class JavacTask extends Object implements JavaCompiler.CompilationTask
Provides access to functionality specific to the JDK Java Compiler, javac.- Since:
- 1.6
-
-
Constructor Summary
Constructors Constructor Description JavacTask()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract voidaddTaskListener(TaskListener taskListener)Adds a specified listener so that it receives notification of events describing the progress of this compilation task.abstract Iterable<? extends Element>analyze()Completes all analysis.abstract Iterable<? extends JavaFileObject>generate()Generates code.abstract ElementsgetElements()Returns a utility object for dealing with program elements.abstract TypeMirrorgetTypeMirror(Iterable<? extends Tree> path)Returns a type mirror of the tree node determined by the specified path.abstract TypesgetTypes()Returns a utility object for dealing with type mirrors.static JavacTaskinstance(ProcessingEnvironment processingEnvironment)Returns theJavacTaskfor aProcessingEnvironment.abstract Iterable<? extends CompilationUnitTree>parse()Parses the specified files returning a list of abstract syntax trees.abstract voidremoveTaskListener(TaskListener taskListener)Removes the specified listener so that it no longer receives notification of events describing the progress of this compilation task.abstract voidsetTaskListener(TaskListener taskListener)Sets a specified listener to receive notification of events describing the progress of this compilation task.-
Methods declared in class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods declared in interface javax.tools.JavaCompiler.CompilationTask
addModules, call, setLocale, setProcessors
-
-
-
-
Method Detail
-
instance
public static JavacTask instance(ProcessingEnvironment processingEnvironment)
Returns theJavacTaskfor aProcessingEnvironment. If the compiler is being invoked using aCompilationTask, then that task will be returned.- Parameters:
processingEnvironment- the processing environment- Returns:
- the
JavacTaskfor aProcessingEnvironment - Since:
- 1.8
-
parse
public abstract Iterable<? extends CompilationUnitTree> parse() throws IOException
Parses the specified files returning a list of abstract syntax trees.- Returns:
- a list of abstract syntax trees
- Throws:
IOException- if an unhandled I/O error occurred in the compiler.IllegalStateException- if the operation cannot be performed at this time.
-
analyze
public abstract Iterable<? extends Element> analyze() throws IOException
Completes all analysis.- Returns:
- a list of elements that were analyzed
- Throws:
IOException- if an unhandled I/O error occurred in the compiler.IllegalStateException- if the operation cannot be performed at this time.
-
generate
public abstract Iterable<? extends JavaFileObject> generate() throws IOException
Generates code.- Returns:
- a list of files that were generated
- Throws:
IOException- if an unhandled I/O error occurred in the compiler.IllegalStateException- if the operation cannot be performed at this time.
-
setTaskListener
public abstract void setTaskListener(TaskListener taskListener)
Sets a specified listener to receive notification of events describing the progress of this compilation task. If another listener is receiving notifications as a result of a prior call of this method, then that listener will no longer receive notifications. Informally, this method is equivalent to callingremoveTaskListenerfor any listener that has been previously set, followed byaddTaskListenerfor the new listener.- Parameters:
taskListener- the task listener- Throws:
IllegalStateException- if the specified listener has already been added.
-
addTaskListener
public abstract void addTaskListener(TaskListener taskListener)
Adds a specified listener so that it receives notification of events describing the progress of this compilation task. This method may be called at any time before or during the compilation.- Parameters:
taskListener- the task listener- Throws:
IllegalStateException- if the specified listener has already been added.- Since:
- 1.8
-
removeTaskListener
public abstract void removeTaskListener(TaskListener taskListener)
Removes the specified listener so that it no longer receives notification of events describing the progress of this compilation task. This method may be called at any time before or during the compilation.- Parameters:
taskListener- the task listener- Since:
- 1.8
-
getTypeMirror
public abstract TypeMirror getTypeMirror(Iterable<? extends Tree> path)
Returns a type mirror of the tree node determined by the specified path. This method has been superceded by methods onTrees.- Parameters:
path- the path- Returns:
- the type mirror
- See Also:
Trees.getTypeMirror(com.sun.source.util.TreePath)
-
getElements
public abstract Elements getElements()
Returns a utility object for dealing with program elements.- Returns:
- a utility object for dealing with program elements
-
getTypes
public abstract Types getTypes()
Returns a utility object for dealing with type mirrors.- Returns:
- the utility object for dealing with type mirrors
-
-