JavaCompiler (jdk.compiler 1.8.132 API)

java.lang.Object
- com.sun.tools.javac.main.JavaCompiler

Direct Known Subclasses:

JavaCompilerWithDeps
```
public class JavaCompiler
extends Object
```
This class could be the main entry point for GJC when GJC is used as a component in a larger software system. It provides operations to construct a new compiler, and to run a new compiler on a set of source files.
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
`protected static class`	`JavaCompiler.CompilePolicy` Control how the compiler's latter phases (attr, flow, desugar, generate) are connected.
`protected static class`	`JavaCompiler.ImplicitSourcePolicy`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Annotate`	`annotate` The annotation annotator.
`protected boolean`	`annotationProcessingOccurred` Flag set if any annotation processing occurred.
`protected Attr`	`attr` The attributor.
`boolean`	`attrParseOnly` Generate attributed parse tree only.
`protected Check`	`chk` The attributor.
`List<Closeable>`	`closeables` A list of items to be closed when the compilation is complete.
`protected JavaCompiler.CompilePolicy`	`compilePolicy` The policy for the order in which to perform the compilation
`protected static Context.Key<JavaCompiler>`	`compilerKey` The context key for the compiler.
`protected CompileStates`	`compileStates`
`protected Name`	`completionFailureName` Force a completion failure on this name
`protected Context`	`context`
`protected JavaCompiler`	`delegateCompiler` Annotation processing may require and provide a new instance of the compiler to be used for the analyze and generate phases.
`protected boolean`	`devVerbose` Switch: should we debug ignored exceptions
`long`	`elapsed_msec`
`String`	`encoding` The encoding to be used for source input.
`protected Enter`	`enter` The module for the symbol table entry phases.
`protected boolean`	`explicitAnnotationProcessingRequested` Switch: is annotation processing requested explicitly via CompilationTask.setProcessors?
`protected JavaFileManager`	`fileManager` Access to file objects.
`protected Flow`	`flow` The flow analyzer.
`protected Gen`	`gen` The module for code generation.
`boolean`	`genEndPos` Switch: should we store the ending positions?
`protected boolean`	`implicitSourceFilesRead` Flag set if any implicit source files read.
`protected JavaCompiler.ImplicitSourcePolicy`	`implicitSourcePolicy` The policy for what to do with implicitly read source files
`protected Set<JavaFileObject>`	`inputFiles` The set of currently compiled inputfiles, needed to ensure we don't accidentally overwrite an input file when -s is set.
`protected JNIWriter`	`jniWriter` The native header writer.
`boolean`	`keepComments`
`boolean`	`lineDebugInfo` Generate code with the LineNumberTable attribute for debugging
`Log`	`log` The log to be used for error reporting.
`protected Lower`	`lower` The syntactic sugar desweetener.
`protected TreeMaker`	`make` The tree factory module.
`protected Names`	`names` The name table.
`protected boolean`	`needRootClasses` Set needRootClasses to true, in JavaCompiler subclass constructor that want to collect public apis of classes supplied on the command line.
`protected Options`	`options` Command line options.
`protected ParserFactory`	`parserFactory` Factory for parsers.
`boolean`	`printFlat` Debug switch: Emit Java sources after inner class flattening.
`protected boolean`	`processPcks` Switch: should we (annotation) process packages as well
`protected ClassReader`	`reader` The class reader.
`CompileStates.CompileState`	`shouldStopPolicyIfError` Policy of how far to continue compilation after errors have occurred.
`CompileStates.CompileState`	`shouldStopPolicyIfNoError` Policy of how far to continue compilation when no errors have occurred.
`protected Source`	`source` The language version.
`boolean`	`sourceOutput` Emit plain Java source files rather than class files.
`boolean`	`stubOutput` Emit stub source files rather than class files.
`protected Symtab`	`syms` The symbol table.
`protected MultiTaskListener`	`taskListener` Broadcasting listener for progress events
`protected ClassReader.SourceCompleter`	`thisCompleter` SourceCompleter that delegates to the complete-method of this class.
`Todo`	`todo` A queue of all as yet unattributed classes.
`protected TransTypes`	`transTypes` The type eraser.
`protected Types`	`types` Type utilities.
`boolean`	`verbose` Verbose output.
`boolean`	`verboseCompilePolicy` Report activity related to compilePolicy
`protected boolean`	`werror` Switch: treat warnings as errors
`protected ClassWriter`	`writer` The class writer.

Constructor Summary

Constructors
Constructor and Description

JavaCompiler(Context context)
Construct a new compiler using a shared context.

Constructors
Constructor and Description
`JavaCompiler(Context context)` Construct a new compiler using a shared context.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Env<AttrContext>`	`attribute(Env<AttrContext> env)` Attribute a parse tree.
`Queue<Env<AttrContext>>`	`attribute(Queue<Env<AttrContext>> envs)` Attribute a list of parse trees, such as found on the "todo" list.
`void`	`close()` Close the compiler, flushing the logs
`void`	`close(boolean disposeNames)`
`void`	`compile(List<JavaFileObject> sourceFileObject)`
`void`	`compile(List<JavaFileObject> sourceFileObjects, List<String> classnames, Iterable<? extends Processor> processors)` Main method: compile a list of files, return all compiled classes
`void`	`complete(Symbol.ClassSymbol c)` Complete compiling a source file that has been accessed by the class file reader.
`protected void`	`desugar(Env<AttrContext> env, Queue<Pair<Env<AttrContext>,JCTree.JCClassDecl>> results)` Prepare attributed parse trees, in conjunction with their attribution contexts, for source or code generation.
`Queue<Pair<Env<AttrContext>,JCTree.JCClassDecl>>`	`desugar(Queue<Env<AttrContext>> envs)` Prepare attributed parse trees, in conjunction with their attribution contexts, for source or code generation.
`List<JCTree.JCCompilationUnit>`	`enterTrees(List<JCTree.JCCompilationUnit> roots)` Enter the symbols found in a list of parse trees.
`List<JCTree.JCCompilationUnit>`	`enterTreesIfNeeded(List<JCTree.JCCompilationUnit> roots)` Enter the symbols found in a list of parse trees if the compilation is expected to proceed beyond anno processing into attr.
`int`	`errorCount()` The number of errors reported so far.
`Queue<Env<AttrContext>>`	`flow(Env<AttrContext> env)` Perform dataflow checks on an attributed parse tree.
`protected void`	`flow(Env<AttrContext> env, Queue<Env<AttrContext>> results)` Perform dataflow checks on an attributed parse tree.
`Queue<Env<AttrContext>>`	`flow(Queue<Env<AttrContext>> envs)` Perform dataflow checks on attributed parse trees.
`static String`	`fullVersion()` The current full version number as a string.
`void`	`generate(Queue<Pair<Env<AttrContext>,JCTree.JCClassDecl>> queue)` Generates the source or class file for a list of classes.
`void`	`generate(Queue<Pair<Env<AttrContext>,JCTree.JCClassDecl>> queue, Queue<JavaFileObject> results)`
`void`	`initProcessAnnotations(Iterable<? extends Processor> processors)` Check if we should process annotations.
`void`	`initRound(JavaCompiler prev)`
`static JavaCompiler`	`instance(Context context)` Get the JavaCompiler instance for this context.
`protected boolean`	`keepComments()`
`JCTree.JCCompilationUnit`	`parse(JavaFileObject filename)` Parse contents of file.
`protected JCTree.JCCompilationUnit`	`parse(JavaFileObject filename, CharSequence content)` Parse contents of input stream.
`JCTree.JCCompilationUnit`	`parse(String filename)` Deprecated.
`List<JCTree.JCCompilationUnit>`	`parseFiles(Iterable<JavaFileObject> fileObjects)` Parses a list of files.
`void`	`printCount(String kind, int count)` Print numbers of errors and warnings.
`protected void`	`printNote(String lines)`
`JavaCompiler`	`processAnnotations(List<JCTree.JCCompilationUnit> roots)`
`JavaCompiler`	`processAnnotations(List<JCTree.JCCompilationUnit> roots, List<String> classnames)` Process any annotations found in the specified compilation units.
`CharSequence`	`readSource(JavaFileObject filename)` Try to open input stream with given name.
`void`	`reportDeferredDiagnostics()`
`void`	`reportPublicApi(Symbol.ClassSymbol sym)` Report the public api of a class that was supplied explicitly for compilation, for example on the command line to javac.
`Symbol`	`resolveBinaryNameOrIdent(String name)` Resolve an identifier which may be the binary name of a class or the Java name of a class or package.
`Symbol`	`resolveIdent(String name)` Resolve an identifier.
`protected boolean`	`shouldStop(CompileStates.CompileState cs)`
`protected <T> List<T>`	`stopIfError(CompileStates.CompileState cs, List<T> list)`
`protected <T> Queue<T>`	`stopIfError(CompileStates.CompileState cs, Queue<T> queue)`
`static String`	`version()` The current version number as a string.
`int`	`warningCount()` The number of warnings reported so far.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - compilerKey
```
protected static final Context.Key<JavaCompiler> compilerKey
```
    The context key for the compiler.
  - log
```
public Log log
```
    The log to be used for error reporting.
  - make
```
protected TreeMaker make
```
    The tree factory module.
  - reader
```
protected ClassReader reader
```
    The class reader.
  - writer
```
protected ClassWriter writer
```
    The class writer.
  - jniWriter
```
protected JNIWriter jniWriter
```
    The native header writer.
  - enter
```
protected Enter enter
```
    The module for the symbol table entry phases.
  - syms
```
protected Symtab syms
```
    The symbol table.
  - source
```
protected Source source
```
    The language version.
  - gen
```
protected Gen gen
```
    The module for code generation.
  - names
```
protected Names names
```
    The name table.
  - attr
```
protected Attr attr
```
    The attributor.
  - chk
```
protected Check chk
```
    The attributor.
  - flow
```
protected Flow flow
```
    The flow analyzer.
  - transTypes
```
protected TransTypes transTypes
```
    The type eraser.
  - lower
```
protected Lower lower
```
    The syntactic sugar desweetener.
  - annotate
```
protected Annotate annotate
```
    The annotation annotator.
  - completionFailureName
```
protected final Name completionFailureName
```
    Force a completion failure on this name
  - types
```
protected Types types
```
    Type utilities.
  - fileManager
```
protected JavaFileManager fileManager
```
    Access to file objects.
  - parserFactory
```
protected ParserFactory parserFactory
```
    Factory for parsers.
  - taskListener
```
protected MultiTaskListener taskListener
```
    Broadcasting listener for progress events
  - delegateCompiler
```
protected JavaCompiler delegateCompiler
```
    Annotation processing may require and provide a new instance of the compiler to be used for the analyze and generate phases.
  - thisCompleter
```
protected final ClassReader.SourceCompleter thisCompleter
```
    SourceCompleter that delegates to the complete-method of this class.
  - options
```
protected Options options
```
    Command line options.
  - context
```
protected Context context
```
  - annotationProcessingOccurred
```
protected boolean annotationProcessingOccurred
```
    Flag set if any annotation processing occurred.
  - implicitSourceFilesRead
```
protected boolean implicitSourceFilesRead
```
    Flag set if any implicit source files read.
  - compileStates
```
protected CompileStates compileStates
```
  - verbose
```
public boolean verbose
```
    Verbose output.
  - sourceOutput
```
public boolean sourceOutput
```
    Emit plain Java source files rather than class files.
  - stubOutput
```
public boolean stubOutput
```
    Emit stub source files rather than class files.
  - attrParseOnly
```
public boolean attrParseOnly
```
    Generate attributed parse tree only.
  - printFlat
```
public boolean printFlat
```
    Debug switch: Emit Java sources after inner class flattening.
  - encoding
```
public String encoding
```
    The encoding to be used for source input.
  - lineDebugInfo
```
public boolean lineDebugInfo
```
    Generate code with the LineNumberTable attribute for debugging
  - genEndPos
```
public boolean genEndPos
```
    Switch: should we store the ending positions?
  - devVerbose
```
protected boolean devVerbose
```
    Switch: should we debug ignored exceptions
  - processPcks
```
protected boolean processPcks
```
    Switch: should we (annotation) process packages as well
  - werror
```
protected boolean werror
```
    Switch: treat warnings as errors
  - explicitAnnotationProcessingRequested
```
protected boolean explicitAnnotationProcessingRequested
```
    Switch: is annotation processing requested explicitly via CompilationTask.setProcessors?
  - compilePolicy
```
protected JavaCompiler.CompilePolicy compilePolicy
```
    The policy for the order in which to perform the compilation
  - implicitSourcePolicy
```
protected JavaCompiler.ImplicitSourcePolicy implicitSourcePolicy
```
    The policy for what to do with implicitly read source files
  - verboseCompilePolicy
```
public boolean verboseCompilePolicy
```
    Report activity related to compilePolicy
  - shouldStopPolicyIfError
```
public CompileStates.CompileState shouldStopPolicyIfError
```
    Policy of how far to continue compilation after errors have occurred. Set this to minimum CompileState (INIT) to stop as soon as possible after errors.
  - shouldStopPolicyIfNoError
```
public CompileStates.CompileState shouldStopPolicyIfNoError
```
    Policy of how far to continue compilation when no errors have occurred. Set this to maximum CompileState (GENERATE) to perform full compilation. Set this lower to perform partial compilation, such as -proc:only.
  - todo
```
public Todo todo
```
    A queue of all as yet unattributed classes.
  - closeables
```
public List<Closeable> closeables
```
    A list of items to be closed when the compilation is complete.
  - inputFiles
```
protected Set<JavaFileObject> inputFiles
```
    The set of currently compiled inputfiles, needed to ensure we don't accidentally overwrite an input file when -s is set. initialized by `compile'.
  - keepComments
```
public boolean keepComments
```
  - elapsed_msec
```
public long elapsed_msec
```
  - needRootClasses
```
protected boolean needRootClasses
```
    Set needRootClasses to true, in JavaCompiler subclass constructor that want to collect public apis of classes supplied on the command line.
- Constructor Detail
  - JavaCompiler
```
public JavaCompiler(Context context)
```
    Construct a new compiler using a shared context.
- Method Detail
  - instance
```
public static JavaCompiler instance(Context context)
```
    Get the JavaCompiler instance for this context.
  - version
```
public static String version()
```
    The current version number as a string.
  - fullVersion
```
public static String fullVersion()
```
    The current full version number as a string.
  - shouldStop
```
protected boolean shouldStop(CompileStates.CompileState cs)
```
  - errorCount
```
public int errorCount()
```
    The number of errors reported so far.
  - stopIfError
```
protected final <T> Queue<T> stopIfError(CompileStates.CompileState cs,
                                         Queue<T> queue)
```
  - stopIfError
```
protected final <T> List<T> stopIfError(CompileStates.CompileState cs,
                                        List<T> list)
```
  - warningCount
```
public int warningCount()
```
    The number of warnings reported so far.
  - readSource
```
public CharSequence readSource(JavaFileObject filename)
```
    Try to open input stream with given name. Report an error if this fails.
    
    Parameters:
    
    filename - The file name of the input stream to be opened.
  - parse
```
protected JCTree.JCCompilationUnit parse(JavaFileObject filename,
                                         CharSequence content)
```
    Parse contents of input stream.
    
    Parameters:
    
    filename - The name of the file from which input stream comes.
    
    content - The characters to be parsed.
  - keepComments
```
protected boolean keepComments()
```
  - parse
```
@Deprecated
public JCTree.JCCompilationUnit parse(String filename)
```
    Deprecated.
    
    Parse contents of file.
    
    Parameters:
    
    filename - The name of the file to be parsed.
  - parse
```
public JCTree.JCCompilationUnit parse(JavaFileObject filename)
```
    Parse contents of file.
    
    Parameters:
    
    filename - The name of the file to be parsed.
  - resolveBinaryNameOrIdent
```
public Symbol resolveBinaryNameOrIdent(String name)
```
    Resolve an identifier which may be the binary name of a class or the Java name of a class or package.
    
    Parameters:
    
    name - The name to resolve
  - resolveIdent
```
public Symbol resolveIdent(String name)
```
    Resolve an identifier.
    
    Parameters:
    
    name - The identifier to resolve
  - complete
```
public void complete(Symbol.ClassSymbol c)
              throws Symbol.CompletionFailure
```
    Complete compiling a source file that has been accessed by the class file reader.
    
    Parameters:
    
    c - The class the source file of which needs to be compiled.
    
    Throws:
    
    Symbol.CompletionFailure
  - compile
```
public void compile(List<JavaFileObject> sourceFileObject)
             throws Throwable
```
    Throws:
    
    Throwable
  - compile
```
public void compile(List<JavaFileObject> sourceFileObjects,
                    List<String> classnames,
                    Iterable<? extends Processor> processors)
```
    Main method: compile a list of files, return all compiled classes
    
    Parameters:
    
    sourceFileObjects - file objects to be compiled
    
    classnames - class names to process for annotations
    
    processors - user provided annotation processors to bypass discovery, null means that no processors were provided
  - parseFiles
```
public List<JCTree.JCCompilationUnit> parseFiles(Iterable<JavaFileObject> fileObjects)
```
    Parses a list of files.
  - enterTreesIfNeeded
```
public List<JCTree.JCCompilationUnit> enterTreesIfNeeded(List<JCTree.JCCompilationUnit> roots)
```
    Enter the symbols found in a list of parse trees if the compilation is expected to proceed beyond anno processing into attr. As a side-effect, this puts elements on the "todo" list. Also stores a list of all top level classes in rootClasses.
  - enterTrees
```
public List<JCTree.JCCompilationUnit> enterTrees(List<JCTree.JCCompilationUnit> roots)
```
    Enter the symbols found in a list of parse trees. As a side-effect, this puts elements on the "todo" list. Also stores a list of all top level classes in rootClasses.
  - initProcessAnnotations
```
public void initProcessAnnotations(Iterable<? extends Processor> processors)
```
    Check if we should process annotations. If so, and if no scanner is yet registered, then set up the DocCommentScanner to catch doc comments, and set keepComments so the parser records them in the compilation unit.
    
    Parameters:
    
    processors - user provided annotation processors to bypass discovery, null means that no processors were provided
  - processAnnotations
```
public JavaCompiler processAnnotations(List<JCTree.JCCompilationUnit> roots)
```
  - processAnnotations
```
public JavaCompiler processAnnotations(List<JCTree.JCCompilationUnit> roots,
                                       List<String> classnames)
```
    Process any annotations found in the specified compilation units.
    
    Parameters:
    
    roots - a list of compilation units
    
    Returns:
    
    an instance of the compiler in which to complete the compilation
  - attribute
```
public Queue<Env<AttrContext>> attribute(Queue<Env<AttrContext>> envs)
```
    Attribute a list of parse trees, such as found on the "todo" list. Note that attributing classes may cause additional files to be parsed and entered via the SourceCompleter. Attribution of the entries in the list does not stop if any errors occur.
  - attribute
```
public Env<AttrContext> attribute(Env<AttrContext> env)
```
    Attribute a parse tree.
  - reportPublicApi
```
public void reportPublicApi(Symbol.ClassSymbol sym)
```
    Report the public api of a class that was supplied explicitly for compilation, for example on the command line to javac.
    
    Parameters:
    
    sym - The symbol of the class.
  - flow
```
public Queue<Env<AttrContext>> flow(Queue<Env<AttrContext>> envs)
```
    Perform dataflow checks on attributed parse trees. These include checks for definite assignment and unreachable statements. If any errors occur, an empty list will be returned.
  - flow
```
public Queue<Env<AttrContext>> flow(Env<AttrContext> env)
```
    Perform dataflow checks on an attributed parse tree.
  - flow
```
protected void flow(Env<AttrContext> env,
                    Queue<Env<AttrContext>> results)
```
    Perform dataflow checks on an attributed parse tree.
  - desugar
```
public Queue<Pair<Env<AttrContext>,JCTree.JCClassDecl>> desugar(Queue<Env<AttrContext>> envs)
```
    Prepare attributed parse trees, in conjunction with their attribution contexts, for source or code generation. If any errors occur, an empty list will be returned.
  - desugar
```
protected void desugar(Env<AttrContext> env,
                       Queue<Pair<Env<AttrContext>,JCTree.JCClassDecl>> results)
```
    Prepare attributed parse trees, in conjunction with their attribution contexts, for source or code generation. If the file was not listed on the command line, the current implicitSourcePolicy is taken into account. The preparation stops as soon as an error is found.
  - generate
```
public void generate(Queue<Pair<Env<AttrContext>,JCTree.JCClassDecl>> queue)
```
    Generates the source or class file for a list of classes. The decision to generate a source file or a class file is based upon the compiler's options. Generation stops if an error occurs while writing files.
  - generate
```
public void generate(Queue<Pair<Env<AttrContext>,JCTree.JCClassDecl>> queue,
                     Queue<JavaFileObject> results)
```
  - reportDeferredDiagnostics
```
public void reportDeferredDiagnostics()
```
  - close
```
public void close()
```
    Close the compiler, flushing the logs
  - close
```
public void close(boolean disposeNames)
```
  - printNote
```
protected void printNote(String lines)
```
  - printCount
```
public void printCount(String kind,
                       int count)
```
    Print numbers of errors and warnings.
  - initRound
```
public void initRound(JavaCompiler prev)
```

Class JavaCompiler

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

compilerKey

log

make

reader

writer

jniWriter

enter

syms

source

gen

names

attr

chk

flow

transTypes

lower

annotate

completionFailureName

types

fileManager

parserFactory

taskListener

delegateCompiler

thisCompleter

options

context

annotationProcessingOccurred

implicitSourceFilesRead

compileStates

verbose

sourceOutput

stubOutput

attrParseOnly

printFlat

encoding

lineDebugInfo

genEndPos

devVerbose

processPcks

werror

explicitAnnotationProcessingRequested

compilePolicy

implicitSourcePolicy

verboseCompilePolicy

shouldStopPolicyIfError

shouldStopPolicyIfNoError

todo

closeables

inputFiles

keepComments

elapsed_msec

needRootClasses

Constructor Detail

JavaCompiler

Method Detail

instance

version

fullVersion

shouldStop

errorCount

stopIfError

stopIfError

warningCount

readSource

parse

keepComments

parse

parse

resolveBinaryNameOrIdent

resolveIdent

complete

compile

compile