CompilationUnit (groovy 2.3.0-rc-1 API)

org.codehaus.groovy.control.CompilationUnit

The CompilationUnit collects all compilation data as it is generated by the compiler system. You can use this object to add additional source units to the compilation, or force the compilation to be run again (to affect only the deltas).
You can also add PhaseOperations to this compilation using the addPhaseOperation method. This is commonly used when you want to wire a new AST Transformation into the compilation.
Authors:
Chris Poirier
Jochen Theodorou
Roshan Dawrani

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`CompilationUnit.ClassgenCallback`	Sets a ClassgenCallback.
`static class`	`CompilationUnit.GroovyClassOperation`
`static class`	`CompilationUnit.PrimaryClassNodeOperation`
`static class`	`CompilationUnit.ProgressCallback`
`static class`	`CompilationUnit.SourceUnitOperation`

Field Summary

Fields
Modifiers	Name	Description
`protected CompileUnit`	`ast`
`protected ASTTransformationsContext`	`astTransformationsContext`
`protected ClassNodeResolver`	`classNodeResolver`
`protected Map`	`classSourcesByPublicClassName`
`protected CompilationUnit.ClassgenCallback`	`classgenCallback`	Initializes the CompilationUnit with defaults.
`protected boolean`	`configured`
`protected boolean`	`debug`
`protected List`	`generatedClasses`
`protected List`	`names`
`protected OptimizerVisitor`	`optimizer`
`protected CompilationUnit.ProgressCallback`	`progressCallback`
`protected LinkedList`	`queuedSources`
`protected ResolveVisitor`	`resolveVisitor`
`protected Map`	`sources`
`protected StaticImportVisitor`	`staticImportVisitor`
`protected Map`	`summariesByPublicClassName`
`protected Map`	`summariesBySourceName`
`protected Verifier`	`verifier`

Inherited fields
Fields inherited from class	Fields
`class ProcessingUnit`	`classLoader, configuration, errorCollector, phase, phaseComplete`

Constructor Summary

Constructors
Constructor and description
`CompilationUnit ()`
`CompilationUnit (GroovyClassLoader loader)`
`CompilationUnit (CompilerConfiguration configuration)`
`CompilationUnit (CompilerConfiguration configuration, CodeSource security, GroovyClassLoader loader)`
`CompilationUnit (CompilerConfiguration configuration, CodeSource security, GroovyClassLoader loader, GroovyClassLoader transformLoader)`

Methods Summary

Methods
Type	Name and description
`void`	`addClassNode(ClassNode node)` Adds a ClassNode directly to the unit (ie. without source).
`void`	`addNewPhaseOperation(CompilationUnit.SourceUnitOperation op, int phase)`
`void`	`addPhaseOperation(CompilationUnit.SourceUnitOperation op, int phase)`
`void`	`addPhaseOperation(CompilationUnit.PrimaryClassNodeOperation op, int phase)`
`void`	`addPhaseOperation(CompilationUnit.GroovyClassOperation op)`
`SourceUnit`	`addSource(File file)` Adds a InputStream source to the unit.
`SourceUnit`	`addSource(URL url)`
`SourceUnit`	`addSource(String name, InputStream stream)`
`SourceUnit`	`addSource(String name, String scriptText)`
`SourceUnit`	`addSource(SourceUnit source)` Returns an iterator on the unit's SourceUnits.
`void`	`addSources(String[] paths)` Adds a set of source files to the unit.
`void`	`addSources(File[] files)` Adds a source file to the unit.
`void`	`applyToGeneratedGroovyClasses(CompilationUnit.GroovyClassOperation body)`
`void`	`applyToPrimaryClassNodes(CompilationUnit.PrimaryClassNodeOperation body)`
`void`	`applyToSourceUnits(CompilationUnit.SourceUnitOperation body)`
`void`	`compile()`
`void`	`compile(int throughPhase)`
`void`	`configure(CompilerConfiguration configuration)`
`protected org.objectweb.asm.ClassVisitor`	`createClassVisitor()` Updates the phase marker on all sources.
`protected boolean`	`dequeued()` Resolves all types
`CompileUnit`	`getAST()`
`ASTTransformationsContext`	`getASTTransformationsContext()` @return the AST transformations current context
`ClassNode`	`getClassNode(String name)`
`ClassNodeResolver`	`getClassNodeResolver()`
`Map`	`getClassSourcesByPublicClassName()`
`List`	`getClasses()` Convenience routine to get the named ClassNode.
`CompilationUnit.ClassgenCallback`	`getClassgenCallback()`
`ClassNode`	`getFirstClassNode()`
`CompilationUnit.ProgressCallback`	`getProgressCallback()`
`Map`	`getSummariesByPublicClassName()` Get the GroovyClasses generated by compile().
`Map`	`getSummariesBySourceName()`
`GroovyClassLoader`	`getTransformLoader()` Returns the class loader for loading AST transformations.
`boolean`	`isPublicClass(String className)`
`Iterator`	`iterator()`
`protected void`	`mark()` Marks a single SourceUnit with the current phase, if it isn't already there yet.
`void`	`setClassNodeResolver(ClassNodeResolver classNodeResolver)`
`void`	`setClassgenCallback(CompilationUnit.ClassgenCallback visitor)` Sets a ProgressCallback.
`void`	`setProgressCallback(CompilationUnit.ProgressCallback callback)` Synonym for compile(Phases.ALL).

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class ProcessingUnit`	`completePhase, configure, getClassLoader, getConfiguration, getErrorCollector, getPhase, getPhaseDescription, gotoPhase, nextPhase, setClassLoader, setConfiguration`
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - protected CompileUnit ast
  - protected ASTTransformationsContext astTransformationsContext
  - protected ClassNodeResolver classNodeResolver
  - protected Map classSourcesByPublicClassName
  - protected CompilationUnit.ClassgenCallback classgenCallback
    
    Initializes the CompilationUnit with defaults.
  - protected boolean configured
  - protected boolean debug
  - protected List generatedClasses
  - protected List names
  - protected OptimizerVisitor optimizer
  - protected CompilationUnit.ProgressCallback progressCallback
  - protected LinkedList queuedSources
  - protected ResolveVisitor resolveVisitor
  - protected Map sources
  - protected StaticImportVisitor staticImportVisitor
  - protected Map summariesByPublicClassName
  - protected Map summariesBySourceName
  - protected Verifier verifier
- Constructor Detail
  - public CompilationUnit()
  - public CompilationUnit(GroovyClassLoader loader)
  - public CompilationUnit(CompilerConfiguration configuration)
  - public CompilationUnit(CompilerConfiguration configuration, CodeSource security, GroovyClassLoader loader)
  - public CompilationUnit(CompilerConfiguration configuration, CodeSource security, GroovyClassLoader loader, GroovyClassLoader transformLoader)
- Method Detail
  - public void addClassNode(ClassNode node)
    
    Adds a ClassNode directly to the unit (ie. without source). WARNING: the source is needed for error reporting, using this method without setting a SourceUnit will cause NullPinterExceptions
  - public void addNewPhaseOperation(CompilationUnit.SourceUnitOperation op, int phase)
  - public void addPhaseOperation(CompilationUnit.SourceUnitOperation op, int phase)
  - public void addPhaseOperation(CompilationUnit.PrimaryClassNodeOperation op, int phase)
  - public void addPhaseOperation(CompilationUnit.GroovyClassOperation op)
  - public SourceUnit addSource(File file)
    
    Adds a InputStream source to the unit.
  - public SourceUnit addSource(URL url)
  - public SourceUnit addSource(String name, InputStream stream)
  - public SourceUnit addSource(String name, String scriptText)
  - public SourceUnit addSource(SourceUnit source)
    
    Returns an iterator on the unit's SourceUnits.
  - public void addSources(String[] paths)
    
    Adds a set of source files to the unit.
  - public void addSources(File[] files)
    
    Adds a source file to the unit.
  - public void applyToGeneratedGroovyClasses(CompilationUnit.GroovyClassOperation body)
  - public void applyToPrimaryClassNodes(CompilationUnit.PrimaryClassNodeOperation body)
  - public void applyToSourceUnits(CompilationUnit.SourceUnitOperation body)
  - public void compile()
  - public void compile(int throughPhase)
  - public void configure(CompilerConfiguration configuration)
  - protected org.objectweb.asm.ClassVisitor createClassVisitor()
    
    Updates the phase marker on all sources.
  - protected boolean dequeued()
    
    Resolves all types
  - public CompileUnit getAST()
  - public ASTTransformationsContext getASTTransformationsContext()
    
    Returns:
    the AST transformations current context
  - public ClassNode getClassNode(String name)
  - public ClassNodeResolver getClassNodeResolver()
  - public Map getClassSourcesByPublicClassName()
  - public List getClasses()
    
    Convenience routine to get the named ClassNode.
  - public CompilationUnit.ClassgenCallback getClassgenCallback()
  - public ClassNode getFirstClassNode()
  - public CompilationUnit.ProgressCallback getProgressCallback()
  - public Map getSummariesByPublicClassName()
    
    Get the GroovyClasses generated by compile().
  - public Map getSummariesBySourceName()
  - public GroovyClassLoader getTransformLoader()
    
    Returns the class loader for loading AST transformations.
    Returns:
    - the transform class loader
  - public boolean isPublicClass(String className)
  - public Iterator iterator()
  - protected void mark()
    
    Marks a single SourceUnit with the current phase, if it isn't already there yet.
  - public void setClassNodeResolver(ClassNodeResolver classNodeResolver)
  - public void setClassgenCallback(CompilationUnit.ClassgenCallback visitor)
    
    Sets a ProgressCallback. You can have only one, and setting it to null removes any existing setting.
  - public void setProgressCallback(CompilationUnit.ProgressCallback callback)
    
    Synonym for compile(Phases.ALL).

| Detail:
Field
Constructor
Method

[Java] Class CompilationUnit

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected CompileUnit ast

protected ASTTransformationsContext astTransformationsContext

protected ClassNodeResolver classNodeResolver

protected Map classSourcesByPublicClassName

protected CompilationUnit.ClassgenCallback classgenCallback

protected boolean configured

protected boolean debug

protected List generatedClasses

protected List names

protected OptimizerVisitor optimizer

protected CompilationUnit.ProgressCallback progressCallback

protected LinkedList queuedSources

protected ResolveVisitor resolveVisitor

protected Map sources

protected StaticImportVisitor staticImportVisitor

protected Map summariesByPublicClassName

protected Map summariesBySourceName

protected Verifier verifier

Constructor Detail

public CompilationUnit()

public CompilationUnit(GroovyClassLoader loader)

public CompilationUnit(CompilerConfiguration configuration)

public CompilationUnit(CompilerConfiguration configuration, CodeSource security, GroovyClassLoader loader)

public CompilationUnit(CompilerConfiguration configuration, CodeSource security, GroovyClassLoader loader, GroovyClassLoader transformLoader)

Method Detail

public void addClassNode(ClassNode node)

public void addNewPhaseOperation(CompilationUnit.SourceUnitOperation op, int phase)

public void addPhaseOperation(CompilationUnit.SourceUnitOperation op, int phase)

public void addPhaseOperation(CompilationUnit.PrimaryClassNodeOperation op, int phase)

public void addPhaseOperation(CompilationUnit.GroovyClassOperation op)

public SourceUnit addSource(File file)

public SourceUnit addSource(URL url)

public SourceUnit addSource(String name, InputStream stream)

public SourceUnit addSource(String name, String scriptText)

public SourceUnit addSource(SourceUnit source)

public void addSources(String[] paths)

public void addSources(File[] files)

public void applyToGeneratedGroovyClasses(CompilationUnit.GroovyClassOperation body)

public void applyToPrimaryClassNodes(CompilationUnit.PrimaryClassNodeOperation body)

public void applyToSourceUnits(CompilationUnit.SourceUnitOperation body)

public void compile()

public void compile(int throughPhase)

public void configure(CompilerConfiguration configuration)

protected org.objectweb.asm.ClassVisitor createClassVisitor()

protected boolean dequeued()

public CompileUnit getAST()

public ASTTransformationsContext getASTTransformationsContext()

public ClassNode getClassNode(String name)

public ClassNodeResolver getClassNodeResolver()

public Map getClassSourcesByPublicClassName()

public List getClasses()

public CompilationUnit.ClassgenCallback getClassgenCallback()

public ClassNode getFirstClassNode()

public CompilationUnit.ProgressCallback getProgressCallback()

public Map getSummariesByPublicClassName()

public Map getSummariesBySourceName()

public GroovyClassLoader getTransformLoader()

public boolean isPublicClass(String className)

public Iterator iterator()

protected void mark()

public void setClassNodeResolver(ClassNodeResolver classNodeResolver)

public void setClassgenCallback(CompilationUnit.ClassgenCallback visitor)

public void setProgressCallback(CompilationUnit.ProgressCallback callback)