Top Description Fields Constructors Methods

org.codehaus.groovy.control

public abstract Class ProcessingUnit

Class Inheritance

extends Object

java.lang.Object
org.codehaus.groovy.control.ProcessingUnit

Known Direct Subclasses

org.codehaus.groovy.control.SourceUnit, org.codehaus.groovy.control.CompilationUnit

Imports

groovy.lang.GroovyClassLoader, java.security.AccessController, .PrivilegedAction

A base class for data structures that can collect messages and errors during processing.

Field Summary

Modifier and Type	Field and Description
protected GroovyClassLoader	classLoader The ClassLoader to use during processing
protected CompilerConfiguration	configuration Configuration and other settings that control processing
protected ErrorCollector	errorCollector a helper to share errors and report them
protected int	phase The current phase
protected boolean	phaseComplete True if phase is finished

Constructor Summary

Access	Constructor and Description
public	ProcessingUnit(final CompilerConfiguration configuration, final GroovyClassLoader classLoader, final ErrorCollector errorCollector) Initializes the ProcessingUnit to the empty state.

Method Summary

Modifier and Type	Method and Description
public void	completePhase() Marks the current phase complete and processes any errors.
public void	configure(CompilerConfiguration configuration) Reconfigures the ProcessingUnit.
public GroovyClassLoader	getClassLoader() Returns the class loader in use by this ProcessingUnit.
public CompilerConfiguration	getConfiguration() Gets the CompilerConfiguration for this ProcessingUnit.
public ErrorCollector	getErrorCollector() Errors found during the compilation should be reported through the ErrorCollector.
public int	getPhase() Returns the current phase.
public String	getPhaseDescription() Returns the description for the current phase.
public void	gotoPhase(int phase) Wraps up any pending operations for the current phase and switches to the given phase.
public boolean	isPhaseComplete()
public void	nextPhase() A synonym for `gotoPhase(getPhase() + 1)`.
public void	setClassLoader(final GroovyClassLoader loader) Sets the class loader for use by this ProcessingUnit.
public final void	setConfiguration(CompilerConfiguration configuration) Sets the CompilerConfiguration for this ProcessingUnit.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

classLoader	back to summary
protected GroovyClassLoader classLoader The ClassLoader to use during processing

configuration	back to summary
protected CompilerConfiguration configuration Configuration and other settings that control processing

errorCollector	back to summary
protected ErrorCollector errorCollector a helper to share errors and report them

phase	back to summary
protected int phase The current phase

phaseComplete	back to summary
protected boolean phaseComplete True if phase is finished

Constructor Detail

ProcessingUnit	back to summary
public ProcessingUnit(final CompilerConfiguration configuration, final GroovyClassLoader classLoader, final ErrorCollector errorCollector) Initializes the ProcessingUnit to the empty state.

Method Detail

completePhase	back to summary
public void completePhase() throws CompilationFailedException Marks the current phase complete and processes any errors.

configure	back to summary
public void configure(CompilerConfiguration configuration) Reconfigures the ProcessingUnit.

getClassLoader	back to summary
public GroovyClassLoader getClassLoader() Returns the class loader in use by this ProcessingUnit.

getConfiguration	back to summary
public CompilerConfiguration getConfiguration() Gets the CompilerConfiguration for this ProcessingUnit.

getErrorCollector	back to summary
public ErrorCollector getErrorCollector() Errors found during the compilation should be reported through the ErrorCollector.

getPhase	back to summary
public int getPhase() Returns the current phase.

getPhaseDescription	back to summary
public String getPhaseDescription() Returns the description for the current phase.

gotoPhase	back to summary
public void gotoPhase(int phase) throws CompilationFailedException Wraps up any pending operations for the current phase and switches to the given phase.

isPhaseComplete	back to summary
public boolean isPhaseComplete()

nextPhase	back to summary
public void nextPhase() throws CompilationFailedException A synonym for `gotoPhase(getPhase() + 1)`.

setClassLoader	back to summary
public void setClassLoader(final GroovyClassLoader loader) Sets the class loader for use by this ProcessingUnit.

setConfiguration	back to summary
public final void setConfiguration(CompilerConfiguration configuration) Sets the CompilerConfiguration for this ProcessingUnit.