ProcessingUnit (groovy 2.4.4 API)

org.codehaus.groovy.control.ProcessingUnit

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Field Summary

Fields
Modifiers	Name	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`	Set true if phase is finished

Constructor Summary

Constructors
Constructor and description
`ProcessingUnit (CompilerConfiguration configuration, GroovyClassLoader classLoader, ErrorCollector er)` Initialize the ProcessingUnit to the empty state.

Methods Summary

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

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - 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
    
    Set true if phase is finished
- Constructor Detail
  - public ProcessingUnit(CompilerConfiguration configuration, GroovyClassLoader classLoader, ErrorCollector er)
    
    Initialize the ProcessingUnit to the empty state.
- Method Detail
  - 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()
  - public ErrorCollector getErrorCollector()
    
    Errors found during the compilation should be reported through the ErrorCollector.
    Returns:
    the ErrorCollector for this ProcessingUnit
  - 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 next phase.
  - public void nextPhase()
    
    A synonym for gotoPhase( phase + 1 ).
  - public void setClassLoader(GroovyClassLoader loader)
    
    Sets the class loader for use by this ProcessingUnit.
  - public void setConfiguration(CompilerConfiguration configuration)

Summary:
Field
Constructor
Method

| Detail:
Field
Constructor
Method

[Java] Class ProcessingUnit

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected GroovyClassLoader classLoader

protected CompilerConfiguration configuration

protected ErrorCollector errorCollector

protected int phase

protected boolean phaseComplete

Constructor Detail

public ProcessingUnit(CompilerConfiguration configuration, GroovyClassLoader classLoader, ErrorCollector er)

Method Detail

public void completePhase()

public void configure(CompilerConfiguration configuration)

public GroovyClassLoader getClassLoader()

public CompilerConfiguration getConfiguration()

public ErrorCollector getErrorCollector()

public int getPhase()

public String getPhaseDescription()

public void gotoPhase(int phase)

public void nextPhase()

public void setClassLoader(GroovyClassLoader loader)

public void setConfiguration(CompilerConfiguration configuration)