CompilationInfo (Java Source Base)

java.lang.Object
- org.netbeans.api.java.source.CompilationInfo

Direct Known Subclasses:

CompilationController
```
public class CompilationInfo
extends Object
```
Assorted information about the JavaSource.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CompilationInfo.CacheClearPolicy` Constants to specify when a valued cached by `CompilationInfo.putCachedValue(java.lang.Object, java.lang.Object, org.netbeans.api.java.source.CompilationInfo.CacheClearPolicy)` should be evicted from the cache.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`doInvalidate()`
`static CompilationInfo`	`get(Parser.Result result)` Returns an instance of the `CompilationInfo` for given `Parser.Result` if it is a result of a java parser.
`Object`	`getCachedValue(Object key)` Retrieve a value cached under the given key using the `CompilationInfo.putCachedValue(java.lang.Object, java.lang.Object, org.netbeans.api.java.source.CompilationInfo.CacheClearPolicy)` method.
`TreePath`	`getChangedTree()` Returns tree which was reparsed by an incremental reparse.
`ClasspathInfo`	`getClasspathInfo()` Returns `ClasspathInfo` for which this `CompilationInfo` was created.
`CompilationUnitTree`	`getCompilationUnit()` Returns the javac tree representing the source file.
`List<Diagnostic>`	`getDiagnostics()` Returns the errors in the file represented by the `JavaSource`.
`DocTrees`	`getDocTrees()` Return the `DocTrees` service of the javac represented by this `CompilationInfo`.
`Document`	`getDocument()` Returns `Document` of this `CompilationInfoImpl`
`Elements`	`getElements()` Return the `Elements` service of the javac represented by this `CompilationInfo`.
`ElementUtilities`	`getElementUtilities()` Returns `ElementUtilities`.
`FileObject`	`getFileObject()` Returns the `FileObject` represented by this `CompilationInfo`.
`JavaSource`	`getJavaSource()` Deprecated. Works only when the CompilationInfo was created by JavaSource using the compatibility bridge, when the CompilationInfo was created by the parsing api it returns null. Use `CompilationInfo.getSnapshot()` instead.
`JavaSource.Phase`	`getPhase()` Returns the current phase of the `JavaSource`.
`PositionConverter`	`getPositionConverter()` Deprecated. as of 0.42, this is superseded by Parsing API.
`Snapshot`	`getSnapshot()` Returns the snapshot used by java parser
`SourceVersion`	`getSourceVersion()` Returns the `SourceVersion` used by the javac represented by this `CompilationInfo`.
`String`	`getText()` Returns the content of the file represented by the `JavaSource`.
`TokenHierarchy<?>`	`getTokenHierarchy()` Returns the `TokenHierarchy` for the file represented by the `JavaSource`.
`List<? extends TypeElement>`	`getTopLevelElements()` Returns all top level elements defined in file for which the `CompilationInfo` was created.
`Trees`	`getTrees()` Return the `Trees` service of the javac represented by this `CompilationInfo`.
`TreeUtilities`	`getTreeUtilities()` Returns `TreeUtilities`.
`Types`	`getTypes()` Return the `Types` service of the javac represented by this `CompilationInfo`.
`TypeUtilities`	`getTypeUtilities()` Get the TypeUtilities.
`void`	`putCachedValue(Object key, Object value, CompilationInfo.CacheClearPolicy clearPolicy)` Put a value into a cache under the given key.

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

- Method Detail
  - get
```
@NullUnknown
public static CompilationInfo get(@NonNull
                                               Parser.Result result)
```
    Returns an instance of the CompilationInfo for given Parser.Result if it is a result of a java parser.
    
    Parameters:
    
    result - for which the CompilationInfo should be returned.
    
    Returns:
    
    a CompilationInfo or null when the given result is not a result of java parsing.
    
    Since:
    
    0.42
  - getPhase
```
@NonNull
public JavaSource.Phase getPhase()
```
    Returns the current phase of the JavaSource.
    
    Returns:
    
    JavaSource.Phase the state which was reached by the JavaSource.
  - getChangedTree
```
@CheckForNull
 @CheckReturnValue
public TreePath getChangedTree()
```
    Returns tree which was reparsed by an incremental reparse. When the source file wasn't parsed yet or the parse was a full parse this method returns null.
    Currently the leaf tree is a MethodTree but this may change in the future. Client of this method is responsible to check the corresponding TreeKind to find out if it may perform on the changed subtree or it needs to reprocess the whole tree.
    
    Returns:
    
    TreePath or null
    
    Since:
    
    0.31
  - getCompilationUnit
```
public CompilationUnitTree getCompilationUnit()
```
    Returns the javac tree representing the source file.
    
    Returns:
    
    CompilationUnitTree the compilation unit containing the top level classes contained in the, java source file.
    
    Throws:
    
    IllegalStateException - when the phase is less than JavaSource.Phase.PARSED
  - getText
```
@NonNull
public String getText()
```
    Returns the content of the file represented by the JavaSource.
    
    Returns:
    
    String the java source
  - getSnapshot
```
@NonNull
public Snapshot getSnapshot()
```
    Returns the snapshot used by java parser
    
    Returns:
    
    the snapshot
    
    Since:
    
    0.42
  - getTokenHierarchy
```
@NonNull
public TokenHierarchy<?> getTokenHierarchy()
```
    Returns the TokenHierarchy for the file represented by the JavaSource.
    
    Returns:
    
    lexer TokenHierarchy
  - getDiagnostics
```
@NonNull
public List<Diagnostic> getDiagnostics()
```
    Returns the errors in the file represented by the JavaSource.
    
    Returns:
    
    an list of Diagnostic
  - getTopLevelElements
```
@NullUnknown
public List<? extends TypeElement> getTopLevelElements()
                                                             throws IllegalStateException
```
    Returns all top level elements defined in file for which the CompilationInfo was created. The CompilationInfo has to be in phase JavaSource#Phase#ELEMENTS_RESOLVED.
    
    Returns:
    
    list of top level elements, it may return null when this CompilationInfo is not in phase JavaSource#Phase#ELEMENTS_RESOLVED or higher.
    
    Throws:
    
    IllegalStateException - is thrown when the JavaSource was created with no files
    
    Since:
    
    0.14
  - getTrees
```
@NonNull
public Trees getTrees()
```
    Return the Trees service of the javac represented by this CompilationInfo.
    
    Returns:
    
    javac Trees service
  - getDocTrees
```
@NonNull
public DocTrees getDocTrees()
```
    Return the DocTrees service of the javac represented by this CompilationInfo.
    
    Returns:
    
    javac DocTrees service
    
    Since:
    
    0.124
  - getTypes
```
@NonNull
public Types getTypes()
```
    Return the Types service of the javac represented by this CompilationInfo.
    
    Returns:
    
    javac Types service
  - getElements
```
@NonNull
public Elements getElements()
```
    Return the Elements service of the javac represented by this CompilationInfo.
    
    Returns:
    
    javac Elements service
  - getJavaSource
```
@NullUnknown
public JavaSource getJavaSource()
```
    Deprecated. Works only when the CompilationInfo was created by JavaSource using the compatibility bridge, when the CompilationInfo was created by the parsing api it returns null. Use CompilationInfo.getSnapshot() instead.
    
    Returns JavaSource for which this CompilationInfo was created.
    
    Returns:
    
    JavaSource or null
  - getClasspathInfo
```
@NonNull
public ClasspathInfo getClasspathInfo()
```
    Returns ClasspathInfo for which this CompilationInfo was created.
    
    Returns:
    
    ClasspathInfo
  - getFileObject
```
@NullUnknown
public FileObject getFileObject()
```
    Returns the FileObject represented by this CompilationInfo.
    
    Returns:
    
    FileObject
  - getPositionConverter
```
@Deprecated
public PositionConverter getPositionConverter()
```
    Deprecated. as of 0.42, this is superseded by Parsing API.
    
    Return PositionConverter binding virtual Java source and the real source. Please note that this method is needed only for clients that need to work in non-Java files (e.g. JSP files) or in dialogs, like code completion. Most clients do not need to use PositionConverter.
    
    Returns:
    
    PositionConverter binding the virtual Java source and the real source.
    
    Since:
    
    0.21
  - getDocument
```
@CheckForNull
public Document getDocument()
                                   throws IOException
```
    Returns Document of this CompilationInfoImpl
    
    Returns:
    
    Document or null when the DataObject doesn't exist or has no EditorCookie.
    
    Throws:
    
    IOException
  - getTreeUtilities
```
@NonNull
public TreeUtilities getTreeUtilities()
```
    Returns TreeUtilities.
    
    Returns:
    
    TreeUtilities
  - getElementUtilities
```
@NonNull
public ElementUtilities getElementUtilities()
```
    Returns ElementUtilities.
    
    Returns:
    
    ElementUtilities
  - getTypeUtilities
```
@NonNull
public TypeUtilities getTypeUtilities()
```
    Get the TypeUtilities.
    
    Returns:
    
    an instance of TypeUtilities
  - getSourceVersion
```
@NonNull
public SourceVersion getSourceVersion()
```
    Returns the SourceVersion used by the javac represented by this CompilationInfo.
    
    Returns:
    
    SourceVersion
    
    Since:
    
    0.47
  - getCachedValue
```
@CheckForNull
public Object getCachedValue(@NonNull
                                           Object key)
```
    Retrieve a value cached under the given key using the CompilationInfo.putCachedValue(java.lang.Object, java.lang.Object, org.netbeans.api.java.source.CompilationInfo.CacheClearPolicy) method.
    
    Parameters:
    
    key - for which the cached value should be retrieved
    
    Returns:
    
    value originally passed to CompilationInfo.putCachedValue(java.lang.Object, java.lang.Object, org.netbeans.api.java.source.CompilationInfo.CacheClearPolicy), or null if none
    
    Since:
    
    0.90
  - putCachedValue
```
public void putCachedValue(@NonNull
                           Object key,
                           @NullAllowed
                           Object value,
                           @NonNull
                           CompilationInfo.CacheClearPolicy clearPolicy)
```
    Put a value into a cache under the given key. The #clearPolicy parameter specifies the latest time the references to the key and value should be cleared. The infrastructure is free to clear the references at any earlier time. The clients should not depend on this cache for correctness, only to improve performance.
    
    Parameters:
    
    key - a unique key under which the value should be stored
    
    value - the value to store - any value previously set under the same key will be erased from the cache
    
    clearPolicy - the latest time when the mapping should be cleared from the cache
    
    Since:
    
    0.90
  - doInvalidate
```
protected void doInvalidate()
```

Class CompilationInfo

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

get

getPhase

getChangedTree

getCompilationUnit

getText

getSnapshot

getTokenHierarchy

getDiagnostics

getTopLevelElements

getTrees

getDocTrees

getTypes

getElements

getJavaSource

getClasspathInfo

getFileObject

getPositionConverter

getDocument

getTreeUtilities

getElementUtilities

getTypeUtilities

getSourceVersion

getCachedValue

putCachedValue

doInvalidate