public class Controller extends Object
Modifier and Type | Field and Description |
---|---|
static String |
LAST_SOURCE_CHANGE_CACHE_FILE
The file in the work directory where last source changes
are stored.
|
static String |
NO_CHECKSUM_CONTENT
The content of checksum files if no checksum can be computed.
|
Constructor and Description |
---|
Controller() |
Modifier and Type | Method and Description |
---|---|
protected void |
checkLogging()
Initializes the Logging.
|
protected void |
createOutputFilename(Output output,
ControllerState controllerState)
Creates the output file name and sets it in the output.
|
protected void |
processGenerationUnit(ControllerState controllerState,
UnitConfiguration unitConfiguration)
Processes a unit of generation.
|
void |
run(List<UnitDescriptor> unitDescriptors)
Executes the controller action.
|
Object |
transformSource(Object sourceRoot,
List<SourceTransformerDefinition> transformerDefinitions,
ControllerState controllerState)
Applies all transformer definitions to the current source.
|
public static final String LAST_SOURCE_CHANGE_CACHE_FILE
public static final String NO_CHECKSUM_CONTENT
public void run(List<UnitDescriptor> unitDescriptors) throws GeneratorException
unitDescriptors
- the units of generation to execute.ControllerException
- if a ControllerException occurs during
processing.ConfigurationException
- if a ConfigurationException occurs during
processing.GeneratorException
- if a OutletException occurs during
processing.protected void checkLogging()
protected void processGenerationUnit(ControllerState controllerState, UnitConfiguration unitConfiguration) throws GeneratorException
controllerState
- the controller state, not null.unitConfiguration
- the configuration of the generation unit
to process, not null.GeneratorException
- if a generation error occurs.protected void createOutputFilename(Output output, ControllerState controllerState) throws GeneratorException
output
or is given explicitly (in the latter case
nothing needs to be done).controllerState
- the controller state, not null.output
- The output to process, not null.ConfigurationException
- if an incorrect configuration is
encountered, e.g. if neither filename nor filenameOutlet is
set in output.GeneratorException
- if an error occurs during generation of
the output filename.public Object transformSource(Object sourceRoot, List<SourceTransformerDefinition> transformerDefinitions, ControllerState controllerState) throws SourceTransformerException, SourceException
sourceRoot
- the root element of the source to transform,
not null.transformerDefinitions
- the transformer definitions to apply,
not null.controllerState
- the current controller state, not null.SourceTransformerException
- if error in transformSourceException
- if source not foundCopyright © 2000–2020 The Apache Software Foundation. All rights reserved.